Generate a table that comprehensively summarizes the variability of nucleotide, codon, or amino acid positions. We call these single nucleotide variants (SNVs), single codon variants (SCVs), and single amino acid variants (SAAVs), respectively.
This program takes the variability data stored within a profile-db and compiles it from across samples into a single matrix that comprehensively describes your SNVs, SCVs or SAAVs (a variability-profile-txt).
This program is described on this blog post, so take a look at that for more details.
Let’s talk parameters
Here is a basic run with no bells or whisles:
Note that this program requires you to specify a subset of the databases that you want to focus on, so to focus on everything in the databases, run anvi-script-add-default-collection and use the resulting collection and bin, as shown above.
You can add structural annotations by providing a structure-db.
Focusing on a subset of the input
Instead of focusing on everything (providing the collection
DEFAULT and the bin
EVERYTHING), there are three ways to focus on a subset of the input:
Provide a list of gene caller IDs (as a parameter with the flag
--gene-caller-idsas shown below, or as a file with the flag
Provide a splits-txt to focus only on a specific set of splits.
Additional ways to focus the input
When providing a structure-db, you can also limit your analysis to only genes that have structures in your database.
You can also choose to look at only data from specific samples by providing a file with one sample name per line. For example
my_samples.txt looks like this:
DAY_17A DAY_18A DAY_22A …
SNVs vs. SCVs vs. SAAVs
Which one you’re analyzing depends entirely on the
engine parameter, which you can set to
CDN (codons), or
AA (amino acids). The default value is nucleotides. Note that to analyze SCVs or SAAVs, you’ll have needed to use the flag
--profile-SCVs when you ran anvi-profile.
For example, to analyze SAAVs, run
To analyze SCVs, run
Filtering the output
You can filter the output in various ways, so that you can get straight to the variability positions that you’re most interested in. Here are some of the filters that you can set:
- The maximum number of variable positions that can come from a single split (e.g. to look at a max of 100 SCVs from each split, randomly sampled)
- The maximum and minimum departure from the reference or consensus
- The minimum coverage value in all samples (if a position is covered less than that value in one sample, it will not be reported for all samples)
Adding additional information
You can also set
--quince-mode, which reports the variability data across all samples for each position reported (even if that position isn’t variable in some samples). For example, if nucleotide position 34 of contig 1 was a SNV in one sample, the output would contain data for nucleotide position 34 for all of your samples.
You can also ask the program to report the contig names, split names, and gene-level coverage statistics, which appear as additional columns in the output.
Edit this file to update this information.
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.