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 save results.         โ”‚
โ”‚ --multi      -M                       Run KEGGaNOG in multi mode with        โ”‚
โ”‚                                       multiple eggNOG-mapper annotation      โ”‚
โ”‚                                       files.                                 โ”‚
โ”‚ --overwrite  -overwrite               Overwrite the output directory if it   โ”‚
โ”‚                                       already exists.                        โ”‚
โ”‚ --dpi        -dpi            INTEGER  DPI for the output image.              โ”‚
โ”‚                                       [default: 300]                         โ”‚
โ”‚ --color      -c              TEXT     Cmap for seaborn heatmap.              โ”‚
โ”‚                                       [default: Blues]                       โ”‚
โ”‚ --name       -n              TEXT     Sample name for labeling.              โ”‚
โ”‚                                       [default: SAMPLE]                      โ”‚
โ”‚ --group      -g                       Group the heatmap based on predefined  โ”‚
โ”‚                                       categories.                            โ”‚
โ”‚ --web                                 Launch local web UI in browser 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.3.tar.gz (167.8 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.3-py3-none-any.whl (185.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kegganog-1.6.3.tar.gz
  • Upload date:
  • Size: 167.8 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.3.tar.gz
Algorithm Hash digest
SHA256 911d9bc6b64608853262ae33196312a9023774c9e5d6625f50c29c4a70298d7a
MD5 3e4cddd6010d00d2c7a34bcb589bfbe9
BLAKE2b-256 e9f6ab8f6eae7881b26aa5787d02d14e63084a307e57e8c809f97758aff21525

See more details on using hashes here.

Provenance

The following attestation bundles were made for kegganog-1.6.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: kegganog-1.6.3-py3-none-any.whl
  • Upload date:
  • Size: 185.7 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 da7e8d37be9e44a390920d36c2c545758abdef709d86ed7d63d59ef63964b02e
MD5 bd7464acda0d66ead8a91e92776e5738
BLAKE2b-256 5d091902ecd4e7aeaae412a79bea9540efccbeb2d5f8d4dd9cf8378c171b1e75

See more details on using hashes here.

Provenance

The following attestation bundles were made for kegganog-1.6.3-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