recipe nirvana

Clinical-grade annotation of genomic variants (SNVs, MNVs, insertions, deletions, indels, and SVs)

Homepage:

https://github.com/Illumina/Nirvana

Documentation:

https://illumina.github.io/NirvanaDocumentation/

License:

GPL / GPL-3.0-only

Recipe:

/nirvana/meta.yaml

Nirvana provides clinical-grade annotation of genomic variants. It processes VCF files and outputs structured JSON representations of variant annotations. While this open-source version is no longer actively maintained, users are directed to Illumina Connected Annotations for the current maintained version.

package nirvana

(downloads) docker_nirvana

Versions:

3.18.1-13.18.1-0

Depends:
  • on dotnet-runtime >=6.0,<7.0a0

Additional platforms:

Installation

You need a conda-compatible package manager (currently either pixi, conda, or micromamba) and the Bioconda channel already activated (see Usage). Below, we show how to install with either pixi or conda (for micromamba and mamba, commands are essentially the same as with conda).

Pixi

With pixi installed and the Bioconda channel set up (see Usage), to install globally, run:

pixi global install nirvana

to add into an existing workspace instead, run:

pixi add nirvana

In the latter case, make sure to first add bioconda and conda-forge to the channels considered by the workspace:

pixi workspace channel add conda-forge
pixi workspace channel add bioconda

Conda

With conda installed and the Bioconda channel set up (see Usage), to install into an existing and activated environment, run:

conda install nirvana

Alternatively, to install into a new environment, run:

conda create -n envname nirvana

with envname being the name of the desired environment.

Container

Alternatively, every Bioconda package is available as a container image for usage with your preferred container runtime. For e.g. docker, run:

docker pull quay.io/biocontainers/nirvana:<tag>

(see nirvana/tags for valid values for <tag>).

Integrated deployment

Finally, note that many scientific workflow management systems directly integrate both conda and container based software deployment. Thus, workflow steps can be often directly annotated to use the package, leading to automatic deployment by the respective workflow management system, thereby improving reproducibility and transparency. Check the documentation of your workflow management system to find out about the integration.

Notes

This tool is no longer actively maintained. Users should consider Illumina Connected Annotations for the current maintained version.

Download stats