anvi-compute-gene-cluster-homogeneity

Compute homogeneity for gene clusters.

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

Authors

Requires

pan-db genomes-storage-db

Provides

This program does not seem to provide any artifacts. Such programs usually print out some information for you to see or alter some anvi’o artifacts without producing any immediate outputs.

Usage

This program computes both the geometric homogeneity and functional homogeneity for the gene clusters in a pan-db.

Geometric homogeneity and functional homogeneity are anvi’o specific terms that describe how similar genes within a gene cluster are to each other in different ways. Briefly, geometric homogeneity compares the positions of gaps in the aligned residues without considering specific amino acids, and functional homogeneity examines point mutations to amino acids and compares how similar the resulting amino acids are chemically. See this page for more details.

You can run this program as so:

anvi-compute-gene-cluster-homogeneity -p pan-db \ -g genomes-storage-db \ -o path/to/output.txt \ --store-in-db

This run will put the output directly in the database, as well as provide it as a separate file as the specified output path. When stored in the database, the homogeneity indices are placed in the homogeneity data group of the misc-data-items table.

You also have the option to calculate this information about only specific gene clusters, either by providing a gene cluster ID, list of gene cluster IDs, collection or bin.

To save on runtime, you can also enable --quick-homogeneity, which will not check for horizontal geometric homogenity (i.e. it will not look at alignments within a single gene). This will be less accurate for detailed analyses, but it will run faster.

Here is an example run that uses this flag and only looks at a specific collection:

anvi-compute-gene-cluster-homogeneity -p pan-db \ -g genomes-storage-db \ -o path/to/output.txt \ --store-in-db \ -C collection \ --quick-homogeneity

You can also use multithreading if you’re familiar with that.

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-compute-gene-cluster-homogeneity.

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-compute-gene-cluster-homogeneity [-h] -p PAN_DB [-g GENOMES_STORAGE] [-o FILE_PATH] [--store-in-db] [--gene-cluster-id GENE_CLUSTER_ID] [--gene-cluster-ids-file FILE_PATH] [-C COLLECTION_NAME] [-b BIN_NAME] [--quick-homogeneity] [-T NUM_THREADS] [--just-do-it]

Parameters and their descriptions

INPUT FILES Input files from the pangenome analysis.
-p, --pan-db PAN_DB required
Anvi'o pan database
-g, --genomes-storage GENOMES_STORAGE
Anvi'o genomes storage file
REPORTING How do you want results to be reported? Anvi'o can produce a TAB-delimited output file for you (for which you would have to provide an output file name). Or the results can be stored in the pan database directly, for which you would have to explicitly ask for it. You can get both as well in case you are a fan of redundancy and poor data analysis practices. Anvi'o does not judge.
-o, --output-file FILE_PATH
File path to store results.
--store-in-db
Store analysis results into the database directly.
SELECTION Which gene clusters should be analyzed. You can ask for a single gene cluster, or multiple ones listed in a file, or you can use a collection and bin name to list gene clusters of interest.
--gene-cluster-id GENE_CLUSTER_ID
Gene cluster ID you are interested in.
--gene-cluster-ids-file FILE_PATH
Text file for gene clusters (each line should contain be a unique gene cluster id).
-C, --collection-name COLLECTION_NAME
Collection name.
-b, --bin-id BIN_NAME
Bin name you are interested in.
OPTIONAL Optional stuff available for you to use
--quick-homogeneity
By default, anvi'o will use a homogeneity algorithm that checks for horizontal and vertical geometric homogeneity (along with functional). With this flag, you can tell anvi'o to skip horizontal geometric homogeneity calculations. It will be less accurate but quicker.
-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
--just-do-it
Don't bother me with questions or warnings, just do it.

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.