anvi-script-get-hmm-hits-per-gene-call

A simple script to generate a TAB-delimited file gene caller IDs and their HMM hits for a given HMM source.

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

Authors

Requires

contigs-db

Can use

hmm-source hmm-hits

Provides

functions-txt

Usage

This program lets you convert the hmm-hits within a contigs-db into a functions-txt.

It is similar to anvi-export-functions, except it deals specifically with hmm-hits (which are generated by anvi-run-hmms; in contrast, anvi-export-functions works with the more abstract functions artifact.

Here is an example run of this program:

anvi-script-get-hmm-hits-per-gene-call -c contigs-db \ -o path/to/functions-txt

You also have the option to specify a specific hmm-source, so that only hits from that source are outputted. For example:

anvi-script-get-hmm-hits-per-gene-call -c contigs-db \ -o path/to/functions-txt \ --hmm-source Bacteria_71

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-script-get-hmm-hits-per-gene-call.

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-script-get-hmm-hits-per-gene-call [-h] -c CONTIGS_DB [--hmm-source HMM_ANNOTATION_SOURCE] -o FILE_PATH

Parameters and their descriptions

INPUT: ANVI'O CONTIGS DB
-c, --contigs-db CONTIGS_DB required
Anvi'o contigs database generated by 'anvi-gen-contigs-database'
INPUT: HMM SOURCE
--hmm-source HMM_ANNOTATION_SOURCE
Use a specific HMM source. You can use '--list-hmm-sources' flag to see a list of available resources. The default is 'None'.
OUTPUTTAH
-o, --output-file FILE_PATH required
File path to store results.

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.