Skip to main content

a python package for graphing emapper results

Project description

egger

a python package to plot results from eggnog-mapper

Description

egger can plot COG functional annotations from eggnog-mapper annotation files.

The repository for eggnog-mapper can be found, here.

It has two modes:

  • compare: compares the correlation of COG categories across several genomes.
  • window: plots sliding window plots of COG category distribution across a genome.

See below for usage examples.

Installation

You can install egger with pip.

Either use the PyPI installation: pip install egger.

Or, clone this repository and install manually.

egger only requires Python dependencies, which should be installed automatically.

Usage and Example Output

As described above, egger has two modes:

compare

compare output

egger compare will calculate the correlation of COG category annotations across genomes and build a dendrogram-heatmap. It will write this as .svg file along with the raw data in .tsv formats. It can perform Spearman's rank (-s) or Pearson's (-p) correlation. It can also produce barcharts (-b). Use: egger compare -h for more information.

Here is an example using this repository's example_data/outputs/compare_outputs as the working directory:

$ egger compare -b barchart -s spearmans -p pearsons ../../inputs/annotations/*

compare output

These heatmaps can help identify relationships between genomes or other sequences.

Compare example output

window

window usage

egger window will take eggnog-mapper annotations and plot them using a sliding window. Please note, as eggnog-mapper annotations do not contain location data, the original genome used for the analysis is also required. You will also need to define outputs with -swo or -swp. You can also modify the window and step size using. Use: egger window -h for more information.

Here is an example using this repository's example_data/outputs/window_outputs as the working directory:

egger window -a ../../inputs/annotations/Lactococcus_lactis.annotations -g ../../inputs/genomes/Lactococcus_lactis.gb -swo output_ -swp plot_

window output

This will produce two files:

  1. -swo writes a .tsv file with the raw data used for plotting the sliding window.
  2. -swp writes a .html file for an interactive plot of the sliding window data.

This analysis is particularly useful for finding regions of the genome that are dedicated to a specific function. In the example, Lactococcus lactis has three notable islands for the COG categories J, M and P (among others). example window output

Citation

Coming soon...

Patch Notes

  • v1.0.0 - Initial version

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

egger-1.0.0.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

egger-1.0.0-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

Details for the file egger-1.0.0.tar.gz.

File metadata

  • Download URL: egger-1.0.0.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for egger-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e6bbe6f8a93cf934307f9b6fd81c0a4729cf16462d50aa3675227d035358a0fd
MD5 8708bb07ff3296694aadf3ac36ee8cb6
BLAKE2b-256 b5836bb00791295bc85d1f0c5c0255dca7da2749dff1804e58959fc9bc94531c

See more details on using hashes here.

File details

Details for the file egger-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: egger-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 27.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for egger-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 384f53f8567dd8a16450234eff5f1acff5ca02c46967e9b60ec7cb815d76b9cc
MD5 3872dac85240048f160768f7be1bee21
BLAKE2b-256 6835f6c2510d6cfd3d22265e775b814547206f3b44a58af85d8902fec7281882

See more details on using hashes here.

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