anvi-estimate-genome-completeness

Estimate completion and redundancy using domain-specific single-copy core genes.

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

Authors

Requires

contigs-db

Can use

profile-db external-genomes collection

Provides

completion

Usage

This program estimates the completeness and redundancy of genomes provided to it, based on domain-level single-copy core genes.

Wondering what single-copy core genes anvi’o uses? Check out hmm-source. It uses the tables populated when you ran anvi-run-hmms on your contigs-db.

Genomes provided to this program must be contained in either a bin (within a collection) or a contigs-db (which can be provided alone or as part of an external-genomes).

Running on contigs databases

For example, calling

anvi-estimate-genome-completeness -c contigs-db

will output to the terminal the completition and redundancy of the single-copy core genes in your contigs-db, assuming that all of its contigs represent a single genome. To output this information to a file, you can add the flag -o and provide an output path.

To get this information for several contigs databases at once, you can provide them as an external-genomes, as so:

anvi-estimate-genome-completeness -e external-genomes \ -o completition.txt

Running on bins

To get this data for a series of bins, just provide a profile-db and collection.

anvi-estimate-genome-completeness -c contigs-db \ -p profile-db \ -C collection

To see what collections are contained in your contigs database, call

anvi-estimate-genome-completeness -c contigs-db \ -p profile-db \ --list-collections

or run anvi-show-collections-and-bins for a more comprehensive overview.

If you’re looking for a more comprehensive overview of your entire collection and its contents, the completition and redunduncy statistics for your bins are also included when you run anvi-summarize.

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-estimate-genome-completeness.

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-estimate-genome-completeness [-h] [-c CONTIGS_DB] [-e FILE_PATH] [-i FILE_PATH] [-p PROFILE_DB] [-C COLLECTION_NAME] [--list-collections] [--report-all-estimates] [--just-do-it] [--concise] [-o FILE_PATH] [--skip-checking-genome-hashes]

Parameters and their descriptions

MANDATORY INPUT OPTION #1 Minimum input is an anvi'o contigs database. If you provide nothing else, anvi'o will assume that it is a single genome (even if it is not), and give you back what you need.
-c, --contigs-db CONTIGS_DB
Anvi'o contigs database generated by 'anvi-gen-contigs-database'
MANDATORY INPUT OPTION #2 Or you can initiate this with an external genomes file.
-e, --external-genomes FILE_PATH
A two-column TAB-delimited flat text file that lists anvi'o contigs databases. The first item in the header line should read 'name', and the second should read 'contigs_db_path'. Each line in the file should describe a single entry, where the first column is the name of the genome (or MAG), and the second column is the anvi'o contigs database generated for this genome.
-i, --internal-genomes FILE_PATH
A five-column TAB-delimited flat text file. The header line must contain these columns: 'name', 'bin_id', 'collection_id', 'profile_db_path', 'contigs_db_path'. Each line should list a single entry, where 'name' can be any name to describe the anvi'o bin identified as 'bin_id' that is stored in a collection.
ADDITIONAL INPUT (OPTIONAL) You can also give this program an anvi'o profile database along with a collection name. In which case anvi'o will estimate the completion and redundancy of every bin in this collection. Fun.
-p, --profile-db PROFILE_DB
Anvi'o profile database
-C, --collection-name COLLECTION_NAME
Collection name.
PARAMETERS OF CONVENIENCE Because life is already very hard as it is.
--list-collections
Show available collections and exit.
--report-all-estimates
Use this flag to report all C/R estimates, from all domains.
--just-do-it
Don't bother me with questions or warnings, just do it.
--concise
Don't be verbose, print less messages whenever possible.
-o, --output-file FILE_PATH
File path to store results.
--skip-checking-genome-hashes
Use this flag if you would like anvi'o to skip checking genome hashes. This is only relevant if you may have genomes in your internal or external genomes files that have identical sequences with different names AND if you are OK with it. You may be OK with it, for instance, if you are using `anvi-dereplicate-genomes` program to dereplicate genomes desribed in multiple collections in an anvi'o profile database that may be describing the same genome multiple times (see https://github.com/merenlab/anvio/issues/1397 for a case).

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.