Skip to main content

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

Project description

KEGGaNOG

Python3 Pandas Seaborn Matplotlib Numpy KEGG-Decoder License

Linux macOS

Motivation

eggNOG-mapper 🤝 KEGG-Decoder

  • eggNOG-mapper is a beautiful 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

KEGG-Decoder is hardwired into KEGGaNOG
KEGG-Decoder uses python=3.6
That's why KEGGaNOG uses this version too

# Linux / WSL / Intel Macs
conda create -n kegganog python=3.6

# ARM Macs (Apple M1-M4 and so on)
CONDA_SUBDIR=osx-64 conda create -n kegganog python=3.6

conda activate kegganog
pip install kegganog

Usage Guide

usage: KEGGaNOG [-h] -i INPUT -o OUTPUT [-dpi DPI] [-c COLOR] [-n NAME] [-g] [--version]

KEGGaNOG: Link eggnog-mapper and KEGG-Decoder for pathway visualization.

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT, --input INPUT
                        Path to eggnog-mapper output file
  -o OUTPUT, --output OUTPUT
                        Output folder to save results
  -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)
  -g, --group           Group the heatmap based on predefined categories
  --version             show program's version number and exit

🔗 Please also visit KEGGaNOG wiki page

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! 💻🧬

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-0.5.0.tar.gz (22.4 kB view hashes)

Uploaded Source

Built Distribution

KEGGaNOG-0.5.0-py3-none-any.whl (42.0 kB view hashes)

Uploaded Python 3

Supported by

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