anvi-run-interacdome
Run InteracDome on a contigs database.
🔙 To the main page of anvi’o programs and artifacts.
Authors
Requires
contigs-db
interacdome-data 
Provides
binding-frequencies-txt
misc-data-amino-acids 
Usage
This program predicts per-residue binding scores for genes in your contigs-db via the InteracDome database.
The full process is detailed in this blog post. In fact, ideally, all of that information should really be in this very document, but because the blogpost has preceded this document, it hasn’t been translated over yet. So really, you should really be reading that blogpost if you want to get into the nitty gritty details. Otherwise, the quick reference herein should be sufficient.
In summary, this program runs an HMM search of the genes in your contigs-db to all the Pfam gene families that have been annotated with InteracDome binding frequencies. Then, it parses and filters results, associates binding frequencies of HMM match states to the user’s genes of interest, and then stores the resulting per-residue binding frequencies for each gene into the contigs-db as misc-data-amino-acids.
Before running this program, you’ll have to run anvi-setup-interacdome to set up a local copy of InteracDome’s tab-separated files.
Basic Usage
A basic run of this program looks like this:
In addition to storing per-residue binding frequencies as misc-data-amino-acids in your contigs-db, this also outputs additional files prefixed with INTERACDOME by default (the prefix can be changed with -O). These are provided as binding-frequencies-txt files named INTERACDOME-match_state_contributors.txt and INTERACDOME-domain_hits.txt. See binding-frequencies-txt for details.
Parameters
InteracDome offers two different binding frequency datasets that can be chosen with --interacdome-dataset. Choose ‘representable’ to include Pfams that correspond to domain-ligand interactions that had nonredundant instances across three or more distinct PDB structures. InteracDome authors recommend using this collection to learn more about domain binding properties. Choose ‘confident’ to include Pfams that correspond to domain-ligand interactions that had nonredundant instances across three or more distinct PDB entries and achieved a cross-validated precision of at least 0.5. The default is ‘representable’, and you can change it like so:
anvi-run-interacdome -c contigs-db \
--interacdome-dataset confident
This progarm is multi-threaded, so be sure to make use of it:
anvi-run-interacdome -c contigs-db \
--interacdome-dataset confident \
-T 8
Additionally, there are numerous thresholds that you can set:
--min-binding-frequency to ignore very low frequencies. The InteracDome scale is from 0 (most likely not involved in binding) to 1 (most likely involved in binding). The default cutoff is 0.200000.
--min-hit-fraction to remove poor quality HMM hits. The default value is 0.5, so at least half of a profile HMM’s length must align to your gene, otherwise the hit will be discarded.
--information-content-cutoff to ignore low-qulaity domain hits. The default value is 4, which means every amino acid of your gene must match the consensus amino acid of the match state for each mate state with information content greater than 4. Decreasing this cutoff yields an increasingly stringent filter.
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-run-interacdome.
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-run-interacdome [-h] -c CONTIGS_DB [--interacdome-data-dir PATH] [--interacdome-dataset {representable,confident}] [-m FLOAT] [-f FLOAT] [-t FLOAT] [-T NUM_THREADS] [--just-do-it] [-O FILENAME_PREFIX]
Parameters and their descriptions
-c, --contigs-db CONTIGS_DB required
- Anvi'o contigs database generated by 'anvi-gen-contigs-database'
--interacdome-data-dir PATH
- The path for the interacdome data to be stored. If you leave it as is without specifying anything, anvi'o will set up everything in a pre-defined default directory. The advantage of using the default directory at the time of set up is that every user of anvi'o on a computer system will be using a single data directory, but then you may need to run the setup program with superuser privileges. If you don't have superuser privileges, then you can use this parameter to tell anvi'o the location you wish to use to setup your data.
--interacdome-dataset INTERACDOME_DATASET
- Choose 'representable' to include Pfams that correspond to domain-ligand interactions that had nonredundant instances across three or more distinct PDB structures. InteracDomeauthors recommend using this collection to learn more about domain binding properties. Choose 'confident' to include Pfams that correspond to domain-ligand interactions that had nonredundant instances across three or more distinct PDB entries and achieved a cross-validated precision of at least 0.5. We recommend using this collection to annotate potential ligand-binding positions in protein sequences. The default is 'representable'. Choices:
representable confident Default: representable
-m, --min-binding-frequency FLOAT
- InteracDome has associated binding 'frequencies', which can be considered scores between 0 to 1 that quantify how likely a position is to be involved in binding. Use this parameter to filter out low frequencies. The default is 0.200000. Warning, your contigs database size will grow massively if this is set to 0.0, but you're the boss. Default:
0.2
-f, --min-hit-fraction FLOAT
- Any hits where the hit length--relative to the HMM profile--divided by the total HMM profile length, is less than this value, it will be removed from the results and will not contribute to binding frequencies. The default is 0.5 Default:
0.5
-t, --information-content-cutoff FLOAT
- This parameter can be used to control for low-quality domain hits. Each domain is composed of positions (match states) with varying degrees of conservancy, which can be quantified with information content (IC). High IC means highly conserved. For example, IC = 4 corresponds to 95% of the members of the Pfam sharing the same amino acid at that position. By default, anvi'o demands that for an alignment of a user's gene with a Pfam HMM, the gene sequence must match with the consensus amino acid of each match state that has IC > 4.000000. For context, it is common for a Pfam to not even have a position with an IC > 4, so these represent truly very conserved positions. You can modify this with this parameter. For example, if you think this is dumb, you can set this to 10000, and then no domain hits will be removed for this reason. Default:
4.0
-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.
-O, --output-file-prefix FILENAME_PREFIX
- A prefix to be used while naming the output files. No file type extensions please; just a prefix -- all ouptut file names and extensions will be appended to this prefix. Default:
INTERACDOME
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.