anvi-run-pfams

Run Pfam on Contigs Database.

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

Authors

Requires

contigs-db pfams-data

Provides

functions

Usage

This program associates genes in your contigs-db with functions using the EBI’s Pfam database.

Before you run this program, you’ll have to set up the Pfam database on your computer with the program anvi-setup-pfams.

The Pfam database is based on protein sequences, so anvi’o will convert your genetic information into protein sequences and then use HMMs to compare them to the database.

Unsure what an HMM is? Check out our vocab page

To run, you’ll need to provide a contigs-db. If you stored the pfams-data that you got from running anvi-setup-pfams in a custom location, you’ll need to provide that path as well. The output is a functions artifact.

Here is a default run:

anvi-run-pfams -c contigs-db \ --pfam-data-dir pfams-data

By default, this uses hmmsearch to run HMMs. You can choose to use hmmscan instead by running

anvi-run-pfams -c contigs-db \ --pfam-data-dir pfams-data \ --hmmer-program hmmscan

See this article for a discussion on the performance of the two HMMER programs.

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-pfams.

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-pfams [-h] -c CONTIGS_DB [--pfam-data-dir PFAM_DATA_DIR] [-T NUM_THREADS] [--hmmer-program HMMER_PROGRAM]

Parameters and their descriptions

options
-c, --contigs-db CONTIGS_DB required
Anvi'o contigs database generated by 'anvi-gen-contigs-database'
--pfam-data-dir PFAM_DATA_DIR
The directory path for your Pfam setup. Anvi'o will try to use the default path if you do not specify anything.
-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
--hmmer-program HMMER_PROGRAM
Which of the HMMER programs to use to run HMMs (hmmscan or hmmsearch). By default anvi'o will use hmmscan for typical HMM operations like those in anvi-run-hmms (as these tend to scan a very large number of genes against a relatively small number of HMMs), but if you are using this program to scan a very large number of HMMs, hmmsearch might be a better choice for performance. For this reason, hmmsearch is the default in operations like anvi-run-pfams and anvi-run-kegg-kofams. See this article for a discussion on the performance of these two programs: http://cryptogenomicon.org/hmmscan-vs-hmmsearch-speed-the-numerology.html

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.