Skip to main content

eggnog_mapper

Tags: functional-annotation orthology cog kegg go proteins eggnog sample-scope

Functional annotation of proteins using eggNOG orthology data.

Uses eggNOG-mapper to assign functional annotations to protein sequences. It uses precomputed orthologous groups (OGs) to infer functions like COG categories, KEGG pathways, GO terms, and CAZymes with high precision.

Database Required

Requires the eggNOG database (including the diamond database and taxonomic data) to be available.

Inputs

record (
meta: Record,
faa: Path
)
FieldTypeDescription
metaRecordGroovy Record containing sample information
faaPathProtein sequences in FASTA format (amino acids)
db: Path
NameTypeDescription
dbPathDirectory or compressed tarball containing the eggNOG database

Outputs

record (
meta: Record,
hits: Path,
seed_orthologs: Path,
annotations: Path,
xlsx: Path?,
orthologs: Path?,
genepred: Path?,
gff: Path?,
no_anno: Path?,
pfam: Path?,
results: Set<Path>,
logs: Set<Path?>,
nf_logs: Set<Path>,
versions: Set<Path>
)
FieldTypeDescription
metaRecordSample information record
hitsPathRaw search hits (Diamond/MMseqs2) against the eggNOG database
seed_orthologsPathList of identified seed orthologs used for annotation transfer
annotationsPathMain tab-delimited annotation file (COGs, KEGG, GO, etc.)
xlsxPath?Excel format of the annotations file
orthologsPath?List of fine-grained orthologs
genepredPath?Predicted gene sequences
gffPath?Annotations in GFF format
no_annoPath?FASTA file of sequences that failed to be annotated
pfamPath?Raw PFAM domain hits
resultsSet<Path>All output files to be published
logsSet<Path?>Optional program specific log files
nf_logsSet<Path>Nextflow-specific log files (e.g. .command.{begin
versionsSet<Path>A YAML formatted file with program versions

Parameters

eggNOG Mapper Parameters

ParameterTypeDefaultDescription
--eggnog_genepredstringsearchMethod to use for gene prediction (choices: search, prodigal)
--eggnog_modestringdiamondMethod to search against eggNOG sequences (choices: diamond, hmmer, mmseqs, cache, no_search)

Used By

Subworkflows

  • eggnog - Functional annotation through orthology assignment.

Workflows

  • eggnog - Functional annotation of proteins using orthologous groups and phylogenies.

Citations

If you use this in your analysis, please cite the following.

Source

View source on GitHub

Version

EGGNOG_MAPPER:
- eggnog-mapper: 2.1.13