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

Uploaded Python 3

File details

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

File metadata

  • Download URL: germgenie-0.1.6.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.8 Linux/6.8.0-57-generic

File hashes

Hashes for germgenie-0.1.6.tar.gz
Algorithm Hash digest
SHA256 81294f1de0826c0b2593b312be9415d59bb50f4a49a4765f89fb76276e70eb64
MD5 8068aff71836f61f3e12b028102af039
BLAKE2b-256 5f58abbb2f5083351a6a1842384c2d8320c267098497cc4325264fbce67e7960

See more details on using hashes here.

File details

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

File metadata

  • Download URL: germgenie-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.8 Linux/6.8.0-57-generic

File hashes

Hashes for germgenie-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c7a72966f1227892be0046cb5843c73c849abcbf56ea43b9c5f0bc629f5c3911
MD5 38cf5b35d3fe512c15cccb127ff7348c
BLAKE2b-256 9d63e42783612fd08ef9e6699524348d9a149ab05a9194bba2e81b15d3891b93

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