Skip to main content

A tool for generating KEGG heatmaps from eggNOG-mapper outputs.

Project description

KEGGaNOG

Python3 KEGG-Decoder License codecov

Linux macOS



Motivation

eggNOG-mapper ๐Ÿค KEGG-Decoder

  • eggNOG-mapper is a comprehensive tool for fast functional annotation of novel sequences. Yet it does not provide any visualization functions.
  • KEGG-Decoder is a perfect tool for visualizing KEGG Pathways. But it only takes KEGG-Koala outputs as an input (including blastKOALA, ghostKOALA, KOFAMSCAN).
  • KEGG-Koala is a web-tool which can work for more than 24 hours. eggNOG-mapper can be installed locally on your PC / server and work faster.
  • This tool KEGGaNOG makes eggNOG-mapper meet KEGG-Decoder! It parses eggNOG-mapper output, make it fit for the input to KEGG-Decoder and then visualize KEGG Pathways as the heatmap!
  • Pro-tip: eggNOG-mapper and KEGGaNOG could be wrapped into ๐Ÿ Snakemake pipeline making metabolic profiling a "one-click" process!

Installation

# Linux / WSL / macOS
conda create -n kegganog pip -y
conda activate kegganog
pip install kegganog

Usage Guide

Command-line mode

Usage: KEGGaNOG [OPTIONS]                                                      
                                                                                
 KEGGaNOG: Link eggNOG-mapper and KEGG-Decoder for pathway visualization.       
                                                                                
โ•ญโ”€ Options โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ --input      -i         TEXT                    Path to eggNOG-mapper annotation file. โ”‚
โ”‚ --output     -o         TEXT                    Output folder to saveresults.          โ”‚
โ”‚ --multi      -M                                 Run KEGGaNOG in multi-sample cohort    โ”‚
โ”‚                                                 profile mode.                          โ”‚
โ”‚ --overwrite  -overwrite                         Overwrite the output directory if it   โ”‚
โ”‚                                                 already exists.                        โ”‚
โ”‚ --dpi        -dpi       INTEGER                 DPI resolution mapping index for the   โ”‚
โ”‚                                                 output image visualization.            โ”‚
โ”‚                                                 [default: 300]                         โ”‚
โ”‚ --color      -c         [Blues|Greens|Reds|     Target seaborn color map palette       โ”‚
โ”‚                         Purples|Greys|Oranges]  matrix rule.                           โ”‚
โ”‚                                                 [default: Blues]                       โ”‚
โ”‚ --name       -n         TEXT                    Sample identity text string for        โ”‚
โ”‚                                                 axis labeling.                         โ”‚
โ”‚                                                 [default: SAMPLE]                      โ”‚
โ”‚ --group      -g                                 Group the pathway matrix heatmap rows  โ”‚
โ”‚                                                 based on predefined functional         โ”‚
โ”‚                                                 categories.                            โ”‚
โ”‚ --web                                           Launch the interactive local web UI    โ”‚
โ”‚                                                 dashboard at http://localhost:8000.    โ”‚
โ”‚ --version    -V                                 Show version and exit.                 โ”‚
โ”‚ --help       -h                                 Show this message and exit.            โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

๐Ÿ”— Please visit KEGGaNOG wiki page

Web interface mode

For an interactive, browser-based experience with live preview and advanced visualization options:

KEGGaNOG --web

Then open http://localhost:8000 in your browser.

Features:

  • Live preview โ€” visualize plots in real-time as you adjust parameters
  • Interactive settings โ€” no command-line arguments needed; drop files, tweak colors and dimensions through an intuitive UI
  • Multi-sample analysis โ€” compare samples using heatmaps, radarplots, correlation networks, stacked bars, and streamgraphs
  • Re-render on the fly โ€” modify plot parameters without re-running the full analysis (multi mode only)
  • Download results โ€” export individual plots or the complete results ZIP

Output examples gallery

Default visualization

Single mode Multi mode
heatmap_figure heatmap_figure

These figures are generated using functional groupping mode (-g/--group) and Greens colormap

User APIs visualization

Barplot Boxplot Radarplot Correlation Network
image image image image
Stacked Barplot Streamgraph Stacked Barplot + Streamgraph
kgnstbar_OLD kgnstream_OLD combined_white_OLD

Advantages

  1. Seemless Access to KEGG Annotations: Provides KEGG Ortholog (KO) annotations without requiring a KEGG license.
  2. High-Throughput Capability: Optimized for rapid KO assignment in large-scale datasets, ideal for metagenomics and genomics projects.
  3. Broad Functional Coverage: Leverages the extensive eggNOG database to annotate genes across a wide range of taxa.

Limitation

  1. Indirect KO Mapping: eggNOG-mapper doesnโ€™t directly use the KEGG database, its KO term assignments are inferred through orthologous groups (eggNOG entries). This can sometimes result in less precise annotations.

Tool name background

KEGGaNOG stands for โ€œKEGG out of NOGโ€, highlighting its purpose: extracting KEGG Ortholog annotations from eggNOGโ€™s Non-supervised Orthologous Groups.

Citation

If you use KEGGaNOG in your research, please cite:

Popov, I.V., Chikindas, M.L., Venema, K., Ermakov, A.M. and Popov, I.V., 2025. KEGGaNOG: A Lightweight Tool for KEGG Module Profiling From Orthology-Based Annotations. Molecular Nutrition & Food Research, p.e70269. doi.org/10.1002/mnfr.70269

Acknowledgements

For now KEGGaNOG uses KEGG-Decoder as a main dependecy. I greatly thank KEGG-Decoder's developers.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kegganog-1.6.4.tar.gz (181.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kegganog-1.6.4-py3-none-any.whl (208.1 kB view details)

Uploaded Python 3

File details

Details for the file kegganog-1.6.4.tar.gz.

File metadata

  • Download URL: kegganog-1.6.4.tar.gz
  • Upload date:
  • Size: 181.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kegganog-1.6.4.tar.gz
Algorithm Hash digest
SHA256 4485f31e4eebdc8d0954d48fb91dcae97130a8ec391ab1bb638c435e54475cdb
MD5 b84e374ff177a34eeadfbabbce6526b2
BLAKE2b-256 f6a502bb2a97fd82f083a88d243fce4e0620ed97b63d1f690057bb364fd92120

See more details on using hashes here.

Provenance

The following attestation bundles were made for kegganog-1.6.4.tar.gz:

Publisher: publish.yml on iliapopov17/KEGGaNOG

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kegganog-1.6.4-py3-none-any.whl.

File metadata

  • Download URL: kegganog-1.6.4-py3-none-any.whl
  • Upload date:
  • Size: 208.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kegganog-1.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4c1a00c37cc6503daf091efcf2f2755966a197d01ad54eb3fc7e6a2f454d4769
MD5 e56c8df1d729374c6a86d1f7dc90a114
BLAKE2b-256 717fa4b4be34769d6a8b091ea8c9c79d3086eb440f882eab6de455a01b3b4cf2

See more details on using hashes here.

Provenance

The following attestation bundles were made for kegganog-1.6.4-py3-none-any.whl:

Publisher: publish.yml on iliapopov17/KEGGaNOG

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page