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 details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

Details for the file KEGGaNOG-0.5.0.tar.gz.

File metadata

  • Download URL: KEGGaNOG-0.5.0.tar.gz
  • Upload date:
  • Size: 22.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/1.0.0 urllib3/1.26.20 tqdm/4.64.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.13

File hashes

Hashes for KEGGaNOG-0.5.0.tar.gz
Algorithm Hash digest
SHA256 b329548ea304ebc5fd58fbb5bb02929e87da536130d3fcc66f24f1d2fd1c0564
MD5 cfdd9d6d4997afb4bacb15c01c9453da
BLAKE2b-256 b766e32aa63ab1bdeced8bddfcf4834028b6870427ed972a6df1f000c1441e67

See more details on using hashes here.

File details

Details for the file KEGGaNOG-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: KEGGaNOG-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 42.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/1.0.0 urllib3/1.26.20 tqdm/4.64.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.13

File hashes

Hashes for KEGGaNOG-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ef0776294dc244b4b7f0795c460f06916a6da9be9bb5b94ab91f0ea62c97189
MD5 6791188f93d0f0e18c0ced1fe0456a02
BLAKE2b-256 26c4b4f30253a60f52cac74c7a1942348250725525a0944fa9288732da6d7d2a

See more details on using hashes here.

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