anvi-get-aa-counts

Fetches the number of times each amino acid occurs from a contigs database in a given bin, set of contigs, or set of genes.

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

Authors

Requires

contigs-db

Can use

splits-txt profile-db collection

Provides

aa-frequencies-txt

Usage

Similarly to anvi-get-codon-frequencies, this program counts the number of times each amino acid occurs in a given sequence, whether that’s a collection, bin, set of contigs (listed in a splits-txt), or a set of genes. The output of this is a aa-frequencies-txt.

There are four possible things you can count the amino acid frequencies in:

  • All of the contigs in a contigs-db
  • A series of bins
  • A list of contigs
  • A list of genes

Examples for each are below.

Option 1: all contigs in a contigs-db

To count the amino acids in all of the contigs in a contigs-db, you can just provide the contigs-db of interest, as so:

anvi-get-aa-counts -c contigs-db \ -o path/to/aa-frequencies-txt

Option 2: a series of bins in a collection

To count the amino acid frequencies for a series of bins, you’ll need to provide three additional parameters: the profile-db that you used for binning, the collection that your bins are contained in, and a text file that describes which bins you are interested in. This text file should have only one bin ID per line.

So, your run would look something like this:

anvi-get-aa-counts -c contigs-db \ -o path/to/aa-frequencies-txt \ -p profile-db \ -C collection \ -B my_favorite_bins.txt

my_favorite_bins.txt would look something like this:

bin_00001
bin_00004

Option 3: a list of contigs

Just provide a splits-txt file that lists the contigs you want to look at.

anvi-get-aa-counts -c contigs-db \ -o path/to/aa-frequencies-txt \ --contigs-of-interest splits-txt

Option 4: a list of genes

Just provide a list of gene caller ids, straight into the terminal, like so:

anvi-get-aa-counts -c contigs-db \ -o path/to/aa-frequencies-txt \ --gene-caller-ids gene_1,gene_2,gene_3

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-get-aa-counts.

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-get-aa-counts [-h] -c CONTIGS_DB [-o FILE_PATH] [-p PROFILE_DB] [-C COLLECTION_NAME] [-B FILE_PATH] [--contigs-of-interest FILE] [--gene-caller-ids GENE_CALLER_IDS]

Parameters and their descriptions

MANDATORY STUFF You have to set the following two parameters, then you will select one set of parameters from the following optional sections. If you select nothing from those sets, AA counts for everything in the contigs database will be reported.
-c, --contigs-db CONTIGS_DB required
Anvi'o contigs database generated by 'anvi-gen-contigs-database'
-o, --output-file FILE_PATH
File path to store results.
OPTIONAL PARAMS FOR BINS
-p, --profile-db PROFILE_DB
Anvi'o profile database
-C, --collection-name COLLECTION_NAME
Collection name.
-B, --bin-ids-file FILE_PATH
Text file for bins (each line should be a unique bin id).
OPTIONAL PARAMS FOR CONTIGS
--contigs-of-interest FILE
A file with contig names. There should be only one column in the file, and each line should correspond to a unique split name.
OPTIONAL PARAMS FOR GENE CALLS
--gene-caller-ids GENE_CALLER_IDS
Gene caller ids to focus on. Multiple of them can be declared separated by a delimiter (the default is a comma, and if there is no option to change the delimiter, you must use a comma).In anvi-gen-variability-profile, if you declare nothing you will get all genes matching your other filtering criteria. In other programs, you may get everything, nothing, or an error. It really depends on the situation. Fortunately, mistakes are cheap, so it's worth a try.

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.