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.2.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.2-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: GermGenie-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 3df54954ed662fa1d2d813994616ae7a10125570a71ede4d54e30c4b7d2b9063
MD5 70e7ecd2165d4e772b6806d59527cf3a
BLAKE2b-256 78e00dc97bad52b18e19e47688e82060fc25618f958c103678f249dcb7d98fac

See more details on using hashes here.

File details

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

File metadata

  • Download URL: GermGenie-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 442c051b87d653af6700d91d6c152e454da5f18c1f04e9f1ed3ee2eaa3ab7973
MD5 27c29ec45e67c0ede98148512aa6e0b0
BLAKE2b-256 59e1858b4c4ebd599386f2aa43415e380e7b89fd33326b37df7dda994583f763

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