anvi-run-workflow

Execute, manage, parallelize, and troubleshoot entire 'omics workflows and chain together anvi'o and third party programs.

🔙 To the main page of anvi’o programs and artifacts.

Authors

Can consume

samples-txt fasta-txt workflow-config hmm-list

Can provide

contigs-workflow metagenomics-workflow pangenomics-workflow phylogenomics-workflow trnaseq-workflow ecophylo-workflow sra-download-workflow

Usage

This program allows you to run Snakemake workflows for common anvi’o processes. Some aspects of this program is described in this tutorial, and workflow-specific details can be found in worklfow pages.

Essentially, an anvi’o workflow will run several anvi’o programs for you in quick succession (based on a standard set of initial steps that will allow you to quickly get to a point where you can ask your data novel questions).

As of now, the available workflows are the contigs-workflow, the metagenomics-workflow, the pangenomics-workflow, the phylogenomics-workflow, the trnaseq-workflow, the ecophylo-workflow, and the sra-download-workflow.

Before running the workflow

Each workflow requires a workflow-config: the file that details all of the parameters for the workflow. To get the workflow-config with the default parameters, just run

anvi-run-workflow -w WORKFLOW-NAME \ --get-default-config CONFIG.json

Before running a workflow, it is also a good idea to check the required dependencies by running

anvi-run-workflow -w WORKFLOW-NAME \ --list-dependencies

The main run

The main run of the workflow should look like this:

anvi-run-workflow -w WORKFLOW-NAME \ -c CONFIG.json --save-workflow-graph

The flag --save-workflow-graph creates a visual representation of the anvio programs that the workflow you’re running used.

You can also use the -A flag at the end of the parameter list to change other Snakemake parameters.

Edit this file to update this information.

Additional Resources

Are you aware of resources that may help users better understand the utility of this program? Please feel free to edit this file on GitHub. If you are not sure how to do that, find the __resources__ tag in this file to see an example.