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.8.tar.gz (6.1 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.8-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file germgenie-0.1.8.tar.gz.

File metadata

  • Download URL: germgenie-0.1.8.tar.gz
  • Upload date:
  • Size: 6.1 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.8.tar.gz
Algorithm Hash digest
SHA256 c7c4aa92276826eef90ad1066340f90d686ef4af9fe3d52ab6f44f8bd4e72c12
MD5 71e628e7e554dcd5c40770049eca0526
BLAKE2b-256 6e8e15085b60d19b3a9146424ed80dc2b267d7d8a92f8a740664549e93da903b

See more details on using hashes here.

File details

Details for the file germgenie-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: germgenie-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 6.9 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 6cf047b41a8ecdff7cc175d0cf59caa24cacfba66de3640d36cba8d1bfbbaf7c
MD5 b8d163a569ab0c25ad80864d6312fa29
BLAKE2b-256 c2aaebfa2df1f425c743f86dab692242d5ec35e45604dc3d9cc02d5ab74b50f2

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