anvi-script-kofam-accessions-to-hmms-directory
You give this program one or more KOfam accession ids, and it generates an anvi'o compatible HMM directory to be used with anvi-run-hmms by extracting them from your local KEGG setup..
🔙 To the main page of anvi’o programs and artifacts.
Authors
Requires
kofam-accession
kegg-data 
Provides
hmm-source 
Usage
You give this program one or more KOfam accession ids, and it generates an anvi’o compatible HMM directory hmm-source to be used with anvi-run-hmms by extracting them from your local kegg-data setup.
Basic usage
You may either specify a list of KOfam accessions with --kofam-accessions-list:
anvi-script-kofam-accessions-to-hmms-directory --kofam-accessions-list K00001 K00121 \
-o PROFILE-NAME
Or a file containing this list using --kofam-accessions-file. The file should have one accession number per line:
anvi-script-kofam-accessions-to-hmms-directory --kofam-accessions-file file.txt \
-o PROFILE-NAME
Please note that the PROFILE-NAME will become the name for the HMM source when you use this HMM directory with anvi-run-hmms. So choose the output directory name accordingly, and make sure (1) it does not conflict with any existing HMM source name in your anvi’o setup, and (2) it is descriptive of the profile you are building.
If your KEGG data is not in the default location, you can specify it using --kegg-data-dir:
anvi-script-kofam-accessions-to-hmms-directory --kofam-accessions-list K00001 \
--kegg-data-dir /path/to/KEGGDATA \
-o PROFILE-NAME
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-kofam-accessions-to-hmms-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-kofam-accessions-to-hmms-directory [-h] [--kofam-accessions-list KOFAM_ACCESSION [KOFAM_ACCESSION ...]] [--kofam-accessions-file FILE] [--kegg-data-dir DIR_PATH] [--include-nt-KOs] [-o DIR_PATH]
Parameters and their descriptions
--kofam-accessions-list KOFAM_ACCESSION
- One or more KOfam accession IDs (such as K00001). If you have multiple accessions, you can separate them from each other with a space. If you have too many, consider using the `--kofam-accessions-file` parameter instead.
--kofam-accessions-file FILE
- A single column text file where each column is a single KOfam accession ID (such as K00001). You may have as many accession ids as you like in this file.
--kegg-data-dir DIR_PATH
- The directory path for your KEGG setup, which will include things like KOfam profiles, KEGG MODULE data, and KEGG BRITE data. Anvi'o will try to use the default path if you do not specify anything.
--include-nt-KOs
- 'No-threshold KOs', or 'nt-KOs' are what we call KEGG Orthlogs that KEGG does not provide a bit score threshold for. If you want to include these protein families in your annotations and downstream analyses, then you can use this flag. Anvi'o does something very basic to estimate a bit score threshold for annotating these KOs, which is (1) to download the KEGG GENES sequences associated with each family, (2) to build a new HMM from these GENES (since KEGG GENES updates with new sequences faster than KOfam updates its models), (3) to run HMMER of each new model against the KO's associated sequences, and (4) to take the minimum bit score of those hits as the bit score threshold for the KO. Downstream, we use the anvi'o-generated models to annotate these KO families with their estimated bit score thresholds.
-o, --output-dir DIR_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 the `-H` flag to `anvi-run-hmms`.
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.