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 in your sample. By setting an abundance threshold, any species below the threshold will be added to an 'other' category (>1% by default).
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]
                 [--nreads] [--subsample SUBSAMPLE]
                 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)
  --nreads, -nr         Visualize number of reads per sample in barplot
  --subsample SUBSAMPLE, -s SUBSAMPLE
                        WARNING: DO NOT USE !!!

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.1.1.tar.gz (5.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.1.1-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: GermGenie-0.1.1.tar.gz
  • Upload date:
  • Size: 5.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.1.1.tar.gz
Algorithm Hash digest
SHA256 826c3a53adc6014de65da58ebb3481f3dce5a526358fee1c386ad8d813c0fca8
MD5 c091a175845c3ca80cdfdc62e5e4dbc7
BLAKE2b-256 63ebb8c0123fd946f7329dd75d221d5653f766811bd59c1be1487e3752b40a40

See more details on using hashes here.

File details

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

File metadata

  • Download URL: GermGenie-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.6 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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 19613f16399b9676a05854fab8375fce8c09a1a83823eb1960f58d95d5e210bc
MD5 e0ac70404fdff682879207b46be6f972
BLAKE2b-256 a8d77e3ca3e3fdc53355bdf0a252097a73e77e284534e8d48c690c222c86c85e

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