A tool for generating KEGG heatmaps from eggNOG-mapper outputs.
Project description
KEGGaNOG
Motivation
eggNOG-mapperis a comprehensive tool for fast functional annotation of novel sequences. Yet it does not provide any visualization functions.KEGG-Decoderis a perfect tool for visualizing KEGG Pathways. But it only takesKEGG-Koalaoutputs as an input (including blastKOALA, ghostKOALA, KOFAMSCAN).KEGG-Koalais a web-tool which can work for more than 24 hours.eggNOG-mappercan be installed locally on your PC / server and work faster.- This tool
KEGGaNOGmakeseggNOG-mappermeetKEGG-Decoder! It parseseggNOG-mapperoutput, make it fit for the input toKEGG-Decoderand then visualize KEGG Pathways as the heatmap! - Pro-tip:
eggNOG-mapperandKEGGaNOGcould be wrapped into 🐍Snakemakepipeline 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 [-h] [-M] -i INPUT -o OUTPUT [-overwrite] [-dpi DPI]
[-c COLOR] [-n NAME] [-g] [-V]
KEGGaNOG: Link eggNOG-mapper and KEGG-Decoder for pathway visualization.
options:
-h, --help show this help message and exit
-M, --multi “Multi” mode allows to run KEGGaNOG on multiple
eggNOG-mapper annotation files (a text file with file
location paths must be passed to the input)
-i INPUT, --input INPUT
Path to eggNOG-mapper annotation file
-o OUTPUT, --output OUTPUT
Output folder to save results
-overwrite, --overwrite
Overwrite the output directory if it already exists
-dpi DPI, --dpi DPI DPI for the output image (default: 300)
-c COLOR, --color COLOR, --colour COLOR
Cmap for seaborn heatmap. Recommended options: Greys,
Purples, Blues, Greens, Oranges, Reds (default: Blues)
-n NAME, --name NAME Sample name for labeling (default: SAMPLE) (not active
in `--multi` mode)
-g, --group Group the heatmap based on predefined categories
-V, --version show program's version number and exit
--web Launch local web UI in browser at http://localhost:8000
🔗 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 |
|---|---|
These figures are generated using functional groupping mode (-g/--group) and Greens colormap
User APIs visualization
| Barplot | Boxplot | Radarplot | Correlation Network |
|---|---|---|---|
| Stacked Barplot | Streamgraph | Stacked Barplot + Streamgraph |
|---|---|---|
Advantages
- Seemless Access to KEGG Annotations: Provides KEGG Ortholog (KO) annotations without requiring a KEGG license.
- High-Throughput Capability: Optimized for rapid KO assignment in large-scale datasets, ideal for metagenomics and genomics projects.
- Broad Functional Coverage: Leverages the extensive eggNOG database to annotate genes across a wide range of taxa.
Limitation
- Indirect KO Mapping:
eggNOG-mapperdoesn’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.
Contributing
Contributions are welcome! If you have any ideas, bug fixes, or enhancements, feel free to open an issue or submit a pull request.
Contact
For any inquiries or support, feel free to contact me via email
Happy functional annotation! 💻🧬
Citation
If you use KEGGaNOG in your research, please cite:
Acknowledgements
For now KEGGaNOG uses KEGG-Decoder as a main dependecy. I greatly thank KEGG-Decoder's developers.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kegganog-1.6.1.tar.gz.
File metadata
- Download URL: kegganog-1.6.1.tar.gz
- Upload date:
- Size: 170.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c6ca8cf052119c2e37f0e880ef57978f1462a734f7a2789240e4fec4c3e95b22
|
|
| MD5 |
66c1d2f3ea36947bb7a4a364253a4b79
|
|
| BLAKE2b-256 |
2b9408f05de0c13228fd686a773c204c3462109df42fe3cbbf97641906af9fa7
|
Provenance
The following attestation bundles were made for kegganog-1.6.1.tar.gz:
Publisher:
publish.yml on iliapopov17/KEGGaNOG
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
kegganog-1.6.1.tar.gz -
Subject digest:
c6ca8cf052119c2e37f0e880ef57978f1462a734f7a2789240e4fec4c3e95b22 - Sigstore transparency entry: 1506534900
- Sigstore integration time:
-
Permalink:
iliapopov17/KEGGaNOG@18f33e6a93f3876517a3aa859b4787941d59a23c -
Branch / Tag:
refs/tags/v.1.6.1 - Owner: https://github.com/iliapopov17
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@18f33e6a93f3876517a3aa859b4787941d59a23c -
Trigger Event:
push
-
Statement type:
File details
Details for the file kegganog-1.6.1-py3-none-any.whl.
File metadata
- Download URL: kegganog-1.6.1-py3-none-any.whl
- Upload date:
- Size: 189.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a856c19492874ffbe171668845c232497653f0d3709d86e9cd998cc7d0438daa
|
|
| MD5 |
ebcb1f98b5baf5a317a22339bc4a7bd2
|
|
| BLAKE2b-256 |
8fbfa02846eb84a6e12cfe7f9a9e70ead990f47c880e2adb884659ea655381eb
|
Provenance
The following attestation bundles were made for kegganog-1.6.1-py3-none-any.whl:
Publisher:
publish.yml on iliapopov17/KEGGaNOG
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
kegganog-1.6.1-py3-none-any.whl -
Subject digest:
a856c19492874ffbe171668845c232497653f0d3709d86e9cd998cc7d0438daa - Sigstore transparency entry: 1506535570
- Sigstore integration time:
-
Permalink:
iliapopov17/KEGGaNOG@18f33e6a93f3876517a3aa859b4787941d59a23c -
Branch / Tag:
refs/tags/v.1.6.1 - Owner: https://github.com/iliapopov17
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@18f33e6a93f3876517a3aa859b4787941d59a23c -
Trigger Event:
push
-
Statement type: