anvi-script-hmm-to-hmm-directory

You give this program one or more HMM files from hmmbuild, and it generates an anvi'o compatible HMM directory to be used with anvi-run-hmms.

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

Authors

Requires

hmm-file

Provides

hmm-source

Usage

This script converts a .hmm file as formatted by HMMER3 hmmbuild to an anvi’o compatible hmm-source.

Specifying the input HMM

To start you must point the command to a list of .hmm files you’d like to include in your file hmm-source using the --hmm-list parameter. You may specify one or more files

anvi-script-hmm-to-hmm-directory --hmm-list FILE1.hmm FILE2.hmm

Specifying the input HMM source

Then you must specify a source for the HMM using --hmm-source. Here you have two options. If you specify exactly one source, that will be applied to all the .hmm files passed via --hmm-list.

anvi-script-hmm-to-hmm-directory --hmm-list FILE1.hmm FILE2.hmm --hmm-source COMMON_SOURCE

Otherwise you must specify one source per file passed to --hmm-list.

anvi-script-hmm-to-hmm-directory --hmm-list FILE1.hmm FILE2.hmm --hmm-source SOURCE1 SOURCE2

Specifying the output directory

You must specify the output directory you’d like anvi’o to save your hmm-source into using -o or --output-directory. Anvi’o will create a folder at the path you specify if it does not exist, otherwise it will exit.

anvi-script-hmm-to-hmm-directory -o path/to/output

Basic usage

Putting everything together, a basic command would look like this:

anvi-script-hmm-to-hmm-directory --hmm-list FILE1.hmm --hmm-source SOURCE1 -o output_folder

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-hmm-to-hmm-directory.

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-hmm-to-hmm-directory [-h] [--hmm-list FILES [FILES ...]] [--hmm-source SOURCES [SOURCES ...]] [-o PATH]

Parameters and their descriptions

options
--hmm-list FILES
One or more paths to HMM files. These should have been generated using hmmbuild in HMMER3, or otherwise be in the same format.
--hmm-source SOURCES
The source of these HMMs (e.g. pfam.xfam.org). Specify either one or as many as there are HMM files. Specify this list in the same order as the files in `--hmm-list`
-o, --output-directory PATH
Output directory for the anvi'o-formatted HMMs. Choose the name wisely as this will be the name that will appear in the contigs database after you provide it with `-H` flag to `anvi-run-hmms`. We suggest you to use a name that does not include any special characters or punctuation(such as space, question mark, comma, etc.).

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.