anvi-setup-scg-taxonomy

The purpose of this program is to download necessary information from GTDB (https://gtdb.ecogenomic.org/), and set it up in such a way that your anvi'o installation is able to assign taxonomy to single-copy core genes using anvi-run-scg-taxonomy and estimate taxonomy for genomes or metagenomes using anvi-estimate-scg-taxonomy).

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

Authors

Requires

This program seems to know what its doing. It needs no input material from its user. Good program.

Provides

scgs-taxonomy-db

Usage

This program downloads and sets up the search databases used for the scg-taxonomy workflow (from GTDB) so that you can run anvi-run-scg-taxonomy and anvi-estimate-scg-taxonomy. This program generates a scgs-taxonomy-db artifact, which is required to run both of those programs.

For more information on that workflow, check out this page

You will only have to run this program once per anvi’o installation.

Why is this not done by default? It just makes things easier downstream to build these databases with the DIAMOND installed on your computer to avoid incompatibility issues. Besides, it should take under a minute and is as simple as running

anvi-setup-scg-taxonomy

If you have already already run this program and are trying to redownload this data, run

anvi-setup-scg-taxonomy --reset

You can also download a specific release of this database by providing its URL with the flag --scg-taxonomy-remote-database-url.

Edit this file to update this information.

Command line interface

The following is the list of parameters and their descriptions in the latest version of anvi-setup-scg-taxonomy.

The code that generates this web page ensures that this information is the latest available in 9-dev (eunice). Which means, in some cases the information in this section (generated automatically) might be more comprehensive or up-to-date compared to the descriptions above (written by humans).


Command line usage

anvi-setup-scg-taxonomy [-h] [-T NUM_THREADS] [--scgs-taxonomy-data-dir PATH] [--gtdb-release RELEASE_NUM]

Parameters and their descriptions

options
-T, --num-threads NUM_THREADS
Maximum number of threads to use for multithreading whenever possible. Very conservatively, the default is 1, unless the environmental variable `ANVIO_THREADS` sets another positive integer. If you use this parameter, it will override `ANVIO_THREADS`. It is a good idea to not exceed the number of CPUs / cores on your system. Plus, please be careful with this option if you are running your commands on a SGE -- if you are clusterizing your runs, and asking for multiple threads to use, you may deplete your resources very fast. Default: 1
--scgs-taxonomy-data-dir PATH
The directory for SCGs data to be stored (or read from, depending on the context). If you leave it as is without specifying anything, anvi'o will set up everything in (or try to read things from) a pre-defined default directory. The advantage of using the default directory at the time of set up is that every user of anvi'o on a computer system will be using a single data directory, but then you may need to run the setup program with superuser privileges. If you don't have superuser privileges, then you can use this parameter to tell anvi'o the location you wish to use to setup your databases. If you are using a program (such as `anvi-run-scg-taxonomy` or `anvi-estimate-scg-taxonomy`) you will have to use this parameter to tell those programs where your data are.
--gtdb-release RELEASE_NUM
If you are particularly intersted an earlier release anvi'o knows about, you can set it here Otherwise anvi'o will always use the latest release it knows about.

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.