anvi-import-functions

Parse and store functional annotation of genes.

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

Authors

Requires

contigs-db functions-txt

Provides

functions

Usage

This program takes in a functions-txt to annotate your contigs-db with functions. Basically, if you have already have the gene functions for the contigs in your contigs-db available in a file, you can import them into anvi’o using this command.

You can find a really comprehesive walkthrough of this program on this blog post about importing functions, including information about built-in anvi’o parsers for InterProScan and the EggNOG database.

If you want to overwrite any function annotations you already have, just add the tag --drop-previous-annotations.

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-import-functions.

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-import-functions [-h] -c CONTIGS_DB [-p PARSER] -i FILE(S) [FILE(S) ...] [--drop-previous-annotations]

Parameters and their descriptions

options
-c, --contigs-db CONTIGS_DB required
Anvi'o contigs database generated by 'anvi-gen-contigs-database'
-p, --parser PARSER
Parser to make sense of the input files (if you need one). There are currently 2 parsers readily available: ['interproscan', 'AGNOSTOS']. IT IS OK if you do not select a parser if you have a standard, TAB-delimited input file for funcitonal annotation of genes. If this is not like 2018 and everything is already outdated, you should be able to go to this address and learn everything you need like a boss: http://merenlab.org/2016/06/18/importing-functions/
-i, --input-files FILE(S) required
One or more input files should follow this parameter. The way these files will be handled will depend on which parser you selected (if you did select any).
--drop-previous-annotations
Use this flag if you want anvi'o to remove ALL previous functional annotations for your genes, and then import the new data. The default behavior will add any annotation source into the db incrementally unless there are already annotations from this source. In which case, it will first remove previous annotations for that source only (i.e., if source X is both in the db and in the incoming annotations data, it will replace the content of source X in the db).

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.