Skip to main content

Python wrapper for multi-sample 16S classification using EMU

Project description

GermGenie

GermGenie was specifically designed to analyse 16S data from clinical FFPE specimens, however it can be used to analyse any bacterial sample. GermGenie outputs stacked barplot showing the abundance of every species/genus in your sample. By setting an abundance threshold, any species/genus below the threshold will be added to an 'other' category.
This tool was designed with Oxford Nanopore sequencing reads (ONT), and was not tested with any other sequencing data. The input should be a folder containing one or more samples in a fastq.gz format.

Dependencies

The pipeline is based on EMU. Data is visualized using the Plotly library.

Installation

Follow EMU's installation instructions from the repo.
After installing EMU, install GermGenie in the same conda environment.

python -m pip install GermGenie

Usage

usage: GermGenie [-h] [--threads THREADS] [--threshold THRESHOLD] [--tsv]
                 fastq output db

EMU wrapper for analyzing and plotting relative abundance from 16S data

positional arguments:
  fastq                 Path to folder containing gzipped fastq files
  output                Path to directory to place results (created if not
                        exists.)
  db                    Path to EMU database

optional arguments:
  -h, --help            show this help message and exit
  --threads THREADS, -t THREADS
                        Number of threads to use for EMU classification
                        (defaults to 2)
  --threshold THRESHOLD, -T THRESHOLD
                        Percent abundance threshold. Abundances below
                        threshold will be shown as 'other' (defaults to 1
                        percent)
  --tsv                 Write abundances to tsv file (abundances.tsv)

Developed by Daan Brackel & Sander Boden @ ATLS-Avans

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

GermGenie-0.0.4.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

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

GermGenie-0.0.4-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file GermGenie-0.0.4.tar.gz.

File metadata

  • Download URL: GermGenie-0.0.4.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.12

File hashes

Hashes for GermGenie-0.0.4.tar.gz
Algorithm Hash digest
SHA256 96ff039c6ad78f2c044d9015bf007be40312c0763376579bc6977f6a39646106
MD5 27bae95a16b8e37738757fa9e5bc196a
BLAKE2b-256 1574a4cec588723dec253ca664e7a2a5859f1876aa969f23963589f9721f9fbf

See more details on using hashes here.

File details

Details for the file GermGenie-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: GermGenie-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.12

File hashes

Hashes for GermGenie-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b0be94ba252624fbd05c69e6268e2397fa8cba0c6ec5b849e0f8b6a7f75e1ce6
MD5 1031f12d0c1b695d209d01f801d0042f
BLAKE2b-256 fbc0abcbbde2b4a2c44495c62e8d0e211fca8dab8ca1d8822d46af9e7564d0d4

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