kegganog

๐Ÿค Tool for mining KEGG pathways completeness data from eggNOG-mapper annotations

https://github.com/iliapopov17/kegganog

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • โœ“
    CITATION.cff file
    Found CITATION.cff file
  • โœ“
    codemeta.json file
    Found codemeta.json file
  • โœ“
    .zenodo.json file
    Found .zenodo.json file
  • โ—‹
    DOI references
  • โ—‹
    Academic publication links
  • โ—‹
    Academic email domains
  • โ—‹
    Institutional organization owner
  • โ—‹
    JOSS paper metadata
  • โ—‹
    Scientific vocabulary similarity
    Low similarity (14.9%) to scientific vocabulary

Keywords

eggnog-mapper genome-annotation kegg-ortholog kegg-pathway metabolic-pathways metabolic-profiling
Last synced: 9 months ago · JSON representation ·

Repository

๐Ÿค Tool for mining KEGG pathways completeness data from eggNOG-mapper annotations

Basic Info
Statistics
  • Stars: 13
  • Watchers: 1
  • Forks: 2
  • Open Issues: 0
  • Releases: 0
Topics
eggnog-mapper genome-annotation kegg-ortholog kegg-pathway metabolic-pathways metabolic-profiling
Created over 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

KEGGaNOG



Python3 Pandas Seaborn Matplotlib Numpy KEGG-Decoder License Downloads

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

```bash

Linux / WSL / macOS

conda create -n kegganog pip -y conda activate kegganog pip install kegganog ```

Usage Guide

``` 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 ```

๐Ÿ”— Please visit KEGGaNOG wiki page

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.

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! ๐Ÿ’ป๐Ÿงฌ

Acknowledgements

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

Owner

  • Name: Ilia Popov
  • Login: iliapopov17
  • Kind: user
  • Location: Russia

Citation (CITATION.cff)

cff-version: 0.7.0
message: If you use this software, please cite it as below.
authors:
  - family-names: Popov
    given-names: Ilia
title: "KEGGaNOG"
date-released: 2024-04-26
url: https://github.com/iliapopov17/KEGGaNOG

GitHub Events

Total
  • Issues event: 1
  • Watch event: 10
  • Public event: 1
  • Push event: 66
  • Pull request event: 15
  • Gollum event: 29
  • Fork event: 1
  • Create event: 1
Last Year
  • Issues event: 1
  • Watch event: 10
  • Public event: 1
  • Push event: 66
  • Pull request event: 15
  • Gollum event: 29
  • Fork event: 1
  • Create event: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 1
  • Total pull requests: 7
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 7
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Middle-Author-Bioinformatics (1)
Pull Request Authors
  • iliapopov17 (7)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 239 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 27
  • Total maintainers: 1
pypi.org: kegganog

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

  • Versions: 27
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 239 Last month
Rankings
Dependent packages count: 10.2%
Average: 33.8%
Dependent repos count: 57.3%
Maintainers (1)
Last synced: 10 months ago

Dependencies

requirements.txt pypi
  • biopython ==1.74
  • keggdecoder ==1.3
  • matplotlib ==3.0.3
  • numpy ==1.17.3
  • pandas ==0.25.2
  • plotly ==4.2.1
  • pyparsing ==3.1.4
  • scipy ==1.3.1
  • seaborn ==0.9.0
  • tanglegram ==0.1.0