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. Optional QC is performed with chopper. Data is visualized using the Plotly library.
Installation
Follow EMU's installation instructions from the repo. If you want to filter based on qualityscores or length, install chopper with the instructions from the repo After installing EMU, install conda dependencies and GermGenie in the same conda environment.
conda install -c bioconda chopper
python -m pip install GermGenie
Usage
usage: GermGenie [-h] [--version] [--threads THREADS]
[--threshold THRESHOLD] [--tsv] [--nreads]
[--subsample SUBSAMPLE] [--top_n TOP_N]
[--min-length MIN_LENGTH] [--max-length MAX_LENGTH]
[--min-quality MIN_QUALITY]
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
options:
-h, --help show this help message and exit
--version Show program's version number 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 !!!
--top_n TOP_N, -tn TOP_N
Number of top taxa to plot. 0 for all taxa.
--min-length MIN_LENGTH, -mil MIN_LENGTH
Minimum length of reads to keep. Default is
to keep all reads.
--max-length MAX_LENGTH, -mal MAX_LENGTH
Maximum length of reads to keep. Default is
to keep all reads.
--min-quality MIN_QUALITY, -miq MIN_QUALITY
Minimum average Phred quality score of reads
to keep. Default is to keep all reads.
Developed by Daan Brackel, Birgit Rijvers & Sander Boden @ ATLS-
Avans
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file germgenie-0.1.10.tar.gz.
File metadata
- Download URL: germgenie-0.1.10.tar.gz
- Upload date:
- Size: 7.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c85067ec0289e1f4ce4469b24f5505bd1c5e4796657a141c529bec29026eef9f
|
|
| MD5 |
81b225314bc21e7cac649fecce500b3f
|
|
| BLAKE2b-256 |
a51fc361b02ec176f7ed4dc3199a19036de47f397d68d94fb6b3a9ba80d1cc45
|
File details
Details for the file germgenie-0.1.10-py3-none-any.whl.
File metadata
- Download URL: germgenie-0.1.10-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
16d6c8a589a827064b00fc0f8dfb69778bbc6cb8dbcf15b32ba244333985c7f5
|
|
| MD5 |
ccf59ea083936b6e7ae8d8da6b5df2d9
|
|
| BLAKE2b-256 |
6ba616afbfc219679554140f59f3e5cd87ebcac7ce980890f3a8948230a661db
|