anvi-setup-globdb-functions

Download and set up the GlobDB gene family database for functional annotation.

🔙 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

globdb-data

Usage

This program downloads and sets up a local copy of the GlobDB gene family database for use in functional annotation with anvi-run-globdb-functions. It produces a globdb-data artifact.

Basic usage

anvi-setup-globdb-functions

We recommend using --num-threads to speed up the DIAMOND database build step.

If you already have a globdb-data artifact and want to re-download and rebuild everything from scratch:

anvi-setup-globdb-functions --reset

Custom data directory

By default, anvi’o stores the GlobDB data in a location inside the anvi’o package directory. If you do not have write access to that location, or if you want to keep the data elsewhere, use:

anvi-setup-globdb-functions --globdb-data-dir /path/to/your/directory

You can also set the environment variable ANVIO_GLOBDB_DATA_DIR to your preferred path so anvi’o will use it automatically without requiring the --globdb-data-dir flag each time:

export ANVIO_GLOBDB_DATA_DIR=/path/to/your/directory anvi-setup-globdb-functions

What happens during setup

  1. The GlobDB data package (that is maintained by GlobDB folk, including Daan Speth et al) is downloaded and extracted.
  2. Every gene family info.yaml file is validated for required fields (gene_family, description, version, and cutoffs including lasr, selfmax, selfmin, and matrix). Where present, synteny.yaml files are also validated.
  3. All per-family FASTA files are concatenated into a single GlobDB.faa (with GAA identifiers prepended to sequence headers).
  4. All per-family info.yaml files are merged into a single GlobDB-gene-family-data.yaml. All per-family synteny.yaml files (where present) are merged into a single GlobDB-synteny-data.yaml.
  5. A DIAMOND search database is built from GlobDB.faa.

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-globdb-functions.

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-globdb-functions [-h] [--globdb-data-dir GLOBDB_DATA_DIR] [--reset] [-T NUM_THREADS]

Parameters and their descriptions

options
--globdb-data-dir GLOBDB_DATA_DIR
The directory path for your GlobDB database setup. Anvi'o will try to use the default path if you do not specify anything. Alternatively you can set the environment variable ANVIO_GLOBDB_DATA_DIR to point to a custom location.
--reset
Remove all the previously stored files and start over. If something is feels wrong for some reason and if you believe re-downloading files and setting them up could address the issue, this is the flag that will tell anvi'o to act like a real computer scientist challenged with a computational problem.
-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

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.