recipe annoreport

Summary and visualization tool for MAG gene annotation workflows

Homepage:

https://github.com/keplerridge/annoreport

License:

MIT

Recipe:

/annoreport/meta.yaml

annoreport summarizes annotated gene products across all bins from Prokka or Bakta metagenome annotation workflows. It auto-detects the annotation tool, enriches top gene products via the UniProt REST API, clusters genes by functional category, and produces an interactive HTML report and TSV summary table.

package annoreport

(downloads) docker_annoreport

Versions:

0.1.0-0

Depends:
  • on python >=3.9

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 annoreport

to add into an existing workspace instead, run:

pixi add annoreport

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 annoreport

Alternatively, to install into a new environment, run:

conda create -n envname annoreport

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/annoreport:<tag>

(see annoreport/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.

Download stats