Skip to content

Latest commit

History

209 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

TaFeE Banner

TaFeE — Taxonomic Feature Extraction from Microbiome Sequencing Data

A Snakemake workflow for quality control, taxonomic profiling, and functional annotation of biological sequence data (RE-RRSeq and WGS).


Overview

TaFeE provides modular Snakemake workflows for processing microbiome sequencing data from raw reads through to taxonomic count matrices and functional profiles. Three general-purpose workflow variants are included:

WorkflowSnakefileInputDescription
RE-RRSeq-TaFeEworkflow/RE-RRSeq-TaFeE.smkDemultiplexed RE-RRSeq single-end readsQC, read masking, host/rRNA decontamination, Kraken 2 taxonomy, and taxpasta count matrices for reduced-representation sequencing libraries
TaFeE-prepareworkflow/TaFeE-prepare.smkPaired-end WGS FASTQQC and host/rRNA decontamination of paired-end shotgun reads
TaFeE-profileworkflow/TaFeE-profile.smkKneadData-cleaned paired-end reads (output of TaFeE-prepare)Kraken 2 taxonomic profiling, taxpasta count matrices, host filtering, and HUMAnN 3 functional profiling

An additional helper workflow handles RE-RRSeq demultiplexing:

WorkflowSnakefileDescription
RE-RRSeq-TaFeE-demuxworkflow/RE-RRSeq-TaFeE-demux.smkDemultiplex RE-RRSeq libraries with cutadapt using barcodes

Dependencies

Snakemake & Conda

All workflows require Snakemake ≥ 8 with the cluster-generic executor plugin. A ready-made Conda environment specification is provided:

# workflow/env/conda.yamldependencies:
- conda
- snakedeploy
- snakefmt
- snakemake>=8
- snakemake-executor-plugin-cluster-generic

Create and activate the environment:

conda env create -f workflow/env/conda.yaml -n smk
conda activate smk

Bioinformatics Tool Environments

Each processing step uses its own Conda environment that Snakemake creates automatically via --use-conda. The environment YAML files are located in workflow/env/:

EnvironmentFileKey tools
BBMap 39.01env/bbmap-39.01.yamlbbduk.sh — adapter trimming, quality filtering, entropy masking
PRINSEQ++ 1.2.4env/prinseq-plus-plus-1.2.4.yamlprinseq++ — low-complexity filtering
KneadData 0.12env/kneaddata-0.12.yamlkneaddata — Trimmomatic trimming, TRF repeat removal, Bowtie 2 rRNA decontamination
SeqKit 2.4env/seqkit-2.4.yamlseqkit — FASTQ statistics and read-pair repair
pigz 2.6env/pigz-2.6.yamlpigz — parallel gzip compression
Kraken 2 2.1.3env/kraken2-2.1.3.yamlkraken2 — taxonomic classification
taxpasta 0.7.0env/taxpasta-0.7.0.yamltaxpasta — standardised taxonomic count matrix generation
HUMAnN 3.8env/human-3.8.yamlhumann3 — functional profiling (UniRef50 + MetaCyc)
cutadapt 4.4env/cutadapt-4.4.yamlcutadapt — RE-RRSeq demultiplexing

Reference Databases

The following databases must be downloaded or built and their paths set in config/config.yaml:

Config keyDescription
SILVASILVA 138.2 rRNA Bowtie 2 index directory for KneadData rRNA decontamination
K2INDEXKraken 2 index directory (must contain hash.k2d, opts.k2d, taxo.k2d)
TAXONOMYDirectory containing names.dmp and nodes.dmp for the Kraken 2 index (used by taxpasta)
HOSTSKraken 2 index of host genomes for host-read filtering (TaFeE-profile only)
UNIPROTDBHUMAnN 3 UniRef50/EC-filtered protein database directory (TaFeE-profile only)
TRIMMOMATICPath to a Trimmomatic installation (e.g. ~/.conda/envs/kneaddata/share/trimmomatic-0.39-2)
LINKFARMDirectory containing raw FASTQ symlinks for RE-RRSeq demultiplexing

Configuration

All pipeline parameters are set in config/config.yaml. Key parameters:

# Sequencing library identifier (RE-RRSeq workflows)LIBRARY: SQ1040# Run identifier (WGS workflows)RUN: wgs# Symlink farm for raw RE-RRSeq FASTQ filesLINKFARM: /path/to/fastq-link-farm# Reference database paths (see above)TRIMMOMATIC: "~/.conda/envs/kneaddata/share/trimmomatic-0.39-2"SILVA: /path/to/SILVA138.2K2INDEX: /path/to/kraken2_indexTAXONOMY: /path/to/kraken2_index/taxonomyHOSTS: /path/to/kraken2-hostsUNIPROTDB: /path/to/humann3/uniref50ECFilt

A SLURM cluster profile is provided at config/slurm_profiles/eRI/config.yaml for HPC submission.


Usage

All commands are run from the repository root directory.

1. RE-RRSeq Demultiplexing (RE-RRSeq-TaFeE-demux)

Demultiplex a RE-RRSeq library into per-sample FASTQ files using cutadapt:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE-demux.smk \

2. RE-RRSeq QC, Decontamination & Taxonomic Profiling (RE-RRSeq-TaFeE)

End-to-end processing of demultiplexed RE-RRSeq single-end reads — from read masking through Kraken 2 classification and taxpasta count matrices. Samples with fewer than 25,000 raw reads are automatically excluded.

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \

3. WGS Read Preparation (TaFeE-prepare)

QC and decontamination of paired-end WGS reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-prepare.smk \

4. WGS Taxonomic & Functional Profiling (TaFeE-profile)

Kraken 2 classification, taxpasta matrices, host filtering, and HUMAnN 3 functional profiling of prepared paired-end reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-profile.smk \

Dry Run

Append -n to any command to perform a dry run:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \
-n

Output Results

Directory Structure

Results are written under results/{LIBRARY}/ (RE-RRSeq) or results/{RUN}/ (WGS).

QC Reports (00_QC/)

SeqKit statistics reports are generated at each processing stage to track read counts and quality:

FileDescription
seqkit.report.raw.txtRaw input read statistics
seqkit.report.bbduk.txtPost-BBDuk quality/entropy filtering
seqkit.report.prinseq.txtPost-PRINSEQ++ low-complexity filtering
seqkit.report.KDTrim.txtPost-KneadData Trimmomatic trimming
seqkit.report.KDTRF.txtPost-KneadData TRF repeat removal
seqkit.report.KDSILVA138.txtReads removed by SILVA 138.2 rRNA decontamination
seqkit.report.KDR.txtFinal decontaminated reads

Demultiplexed Reads (01_cutadapt/)

RE-RRSeq workflows only. Per-sample demultiplexed FASTQ files: {sample}.fastq.gz.

Read Masking (01_readMasking/)

Intermediate entropy-filtered (BBDuk) and low-complexity-filtered (PRINSEQ++) reads.

Decontaminated Reads (02_kneaddata/)

KneadData output reads after adapter trimming, TRF repeat removal, and SILVA rRNA decontamination:

  • RE-RRSeq:{sample}.fastq.gz (single-end)
  • WGS:{sample}.KDR.R1.fastq.gz, {sample}.KDR.R2.fastq.gz (paired-end)

Kraken 2 Classification (03_kraken2/)

FileDescription
{sample}.kraken2Kraken 2 report (used by taxpasta)
{sample}.k2.gzCompressed per-read classification output
{sample}.kraken2.classified*.fastq.gzClassified reads (used for downstream functional profiling in WGS)

Taxonomic Count Matrices

Taxpasta merges per-sample Kraken 2 reports into standardised count matrices at multiple taxonomic ranks:

RE-RRSeq (RE-RRSeq-TaFeE):

FileFormat
{LIBRARY}.kraken2.domain.counts.tsvTSV
{LIBRARY}.kraken2.phylum.counts.tsvTSV
{LIBRARY}.kraken2.class.counts.tsvTSV
{LIBRARY}.kraken2.order.counts.tsvTSV
{LIBRARY}.kraken2.family.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.tsvTSV
{LIBRARY}.kraken2.species.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.biomBIOM

WGS (TaFeE-profile):

FileFormat
kraken2.domain.tsvTSV
kraken2.phylum.tsvTSV
kraken2.class.tsvTSV
kraken2.order.tsvTSV
kraken2.family.tsvTSV
kraken2.genus.tsvTSV
kraken2.species.tsvTSV
kraken2.genus.biomBIOM

All TSV matrices include taxonomy ID, name, rank, and full lineage columns.

Host/Microbe Classification Proportions (04_k2_filtering/)

WGS only. Per-sample summary of read classification:

  • {sample}.classification.proportions.txt — counts of microbe, host, and unclassified reads

Functional Profiles (05_functional/)

WGS only. HUMAnN 3 functional profiling outputs (merged across all samples):

FileDescription
humann3_uniref50EC_microbial_pathabundance.rpk.tsvMetaCyc pathway abundance (RPK)
humann3_uniref50EC_microbial_pathcoverage.rpk.tsvMetaCyc pathway coverage
humann3_uniref50EC_microbial_genefamilies.rpk.tsvUniRef50 gene family abundance (RPK)
humann3_uniref50EC_microbial_genefamilies.rpk.KO.tsvGene families regrouped to KEGG Orthologs
humann3_uniref50EC_microbial_genefamilies.rpk.EC.tsvGene families regrouped to Enzyme Commission
humann3_uniref50EC_microbial_genefamilies.rpk.pfam.tsvGene families regrouped to Pfam
humann3_uniref50EC_microbial_genefamilies.rpk.EggNOG.tsvGene families regrouped to EggNOG
humann3_uniref50EC_microbial_genefamilies.rpk.cpm.QC.tsvGene families normalised to CPM
humann3_uniref50EC_microbial_pathabundance.rpk.cpm.QC.tsvPathway abundance normalised to CPM

Benchmarks

Runtime and resource usage for every rule are recorded under results/{LIBRARY or RUN}/benchmarks/.


Workflow DAG

RE-RRSeq (RE-RRSeq-TaFeE)

Raw RE-RRSeq FASTQ
→ cutadapt (demultiplex)
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData (Trimmomatic + TRF + SILVA rRNA removal)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)

WGS (TaFeE-prepare → TaFeE-profile)

Raw paired-end FASTQ
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData R1/R2 (Trimmomatic + TRF + SILVA rRNA removal)
→ SeqKit pair (read-pair repair)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)
→ Kraken 2 host filter
→ HUMAnN 3 (functional profiling)
→ Regroup (KO, EC, Pfam, EggNOG)
→ Normalise (CPM)

License

MIT License. Copyright (c) 2023-2024 Benjamin J Perry.

About

snakemake workflow for taxonomic profiling of biological sequence data

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - AgResearch/TaFeE: snakemake workflow for taxonomic profiling of biological sequence data · GitHub
Skip to content

Latest commit

History

209 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

TaFeE Banner

TaFeE — Taxonomic Feature Extraction from Microbiome Sequencing Data

A Snakemake workflow for quality control, taxonomic profiling, and functional annotation of biological sequence data (RE-RRSeq and WGS).


Overview

TaFeE provides modular Snakemake workflows for processing microbiome sequencing data from raw reads through to taxonomic count matrices and functional profiles. Three general-purpose workflow variants are included:

WorkflowSnakefileInputDescription
RE-RRSeq-TaFeEworkflow/RE-RRSeq-TaFeE.smkDemultiplexed RE-RRSeq single-end readsQC, read masking, host/rRNA decontamination, Kraken 2 taxonomy, and taxpasta count matrices for reduced-representation sequencing libraries
TaFeE-prepareworkflow/TaFeE-prepare.smkPaired-end WGS FASTQQC and host/rRNA decontamination of paired-end shotgun reads
TaFeE-profileworkflow/TaFeE-profile.smkKneadData-cleaned paired-end reads (output of TaFeE-prepare)Kraken 2 taxonomic profiling, taxpasta count matrices, host filtering, and HUMAnN 3 functional profiling

An additional helper workflow handles RE-RRSeq demultiplexing:

WorkflowSnakefileDescription
RE-RRSeq-TaFeE-demuxworkflow/RE-RRSeq-TaFeE-demux.smkDemultiplex RE-RRSeq libraries with cutadapt using barcodes

Dependencies

Snakemake & Conda

All workflows require Snakemake ≥ 8 with the cluster-generic executor plugin. A ready-made Conda environment specification is provided:

# workflow/env/conda.yamldependencies:
- conda
- snakedeploy
- snakefmt
- snakemake>=8
- snakemake-executor-plugin-cluster-generic

Create and activate the environment:

conda env create -f workflow/env/conda.yaml -n smk
conda activate smk

Bioinformatics Tool Environments

Each processing step uses its own Conda environment that Snakemake creates automatically via --use-conda. The environment YAML files are located in workflow/env/:

EnvironmentFileKey tools
BBMap 39.01env/bbmap-39.01.yamlbbduk.sh — adapter trimming, quality filtering, entropy masking
PRINSEQ++ 1.2.4env/prinseq-plus-plus-1.2.4.yamlprinseq++ — low-complexity filtering
KneadData 0.12env/kneaddata-0.12.yamlkneaddata — Trimmomatic trimming, TRF repeat removal, Bowtie 2 rRNA decontamination
SeqKit 2.4env/seqkit-2.4.yamlseqkit — FASTQ statistics and read-pair repair
pigz 2.6env/pigz-2.6.yamlpigz — parallel gzip compression
Kraken 2 2.1.3env/kraken2-2.1.3.yamlkraken2 — taxonomic classification
taxpasta 0.7.0env/taxpasta-0.7.0.yamltaxpasta — standardised taxonomic count matrix generation
HUMAnN 3.8env/human-3.8.yamlhumann3 — functional profiling (UniRef50 + MetaCyc)
cutadapt 4.4env/cutadapt-4.4.yamlcutadapt — RE-RRSeq demultiplexing

Reference Databases

The following databases must be downloaded or built and their paths set in config/config.yaml:

Config keyDescription
SILVASILVA 138.2 rRNA Bowtie 2 index directory for KneadData rRNA decontamination
K2INDEXKraken 2 index directory (must contain hash.k2d, opts.k2d, taxo.k2d)
TAXONOMYDirectory containing names.dmp and nodes.dmp for the Kraken 2 index (used by taxpasta)
HOSTSKraken 2 index of host genomes for host-read filtering (TaFeE-profile only)
UNIPROTDBHUMAnN 3 UniRef50/EC-filtered protein database directory (TaFeE-profile only)
TRIMMOMATICPath to a Trimmomatic installation (e.g. ~/.conda/envs/kneaddata/share/trimmomatic-0.39-2)
LINKFARMDirectory containing raw FASTQ symlinks for RE-RRSeq demultiplexing

Configuration

All pipeline parameters are set in config/config.yaml. Key parameters:

# Sequencing library identifier (RE-RRSeq workflows)LIBRARY: SQ1040# Run identifier (WGS workflows)RUN: wgs# Symlink farm for raw RE-RRSeq FASTQ filesLINKFARM: /path/to/fastq-link-farm# Reference database paths (see above)TRIMMOMATIC: "~/.conda/envs/kneaddata/share/trimmomatic-0.39-2"SILVA: /path/to/SILVA138.2K2INDEX: /path/to/kraken2_indexTAXONOMY: /path/to/kraken2_index/taxonomyHOSTS: /path/to/kraken2-hostsUNIPROTDB: /path/to/humann3/uniref50ECFilt

A SLURM cluster profile is provided at config/slurm_profiles/eRI/config.yaml for HPC submission.


Usage

All commands are run from the repository root directory.

1. RE-RRSeq Demultiplexing (RE-RRSeq-TaFeE-demux)

Demultiplex a RE-RRSeq library into per-sample FASTQ files using cutadapt:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE-demux.smk \

2. RE-RRSeq QC, Decontamination & Taxonomic Profiling (RE-RRSeq-TaFeE)

End-to-end processing of demultiplexed RE-RRSeq single-end reads — from read masking through Kraken 2 classification and taxpasta count matrices. Samples with fewer than 25,000 raw reads are automatically excluded.

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \

3. WGS Read Preparation (TaFeE-prepare)

QC and decontamination of paired-end WGS reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-prepare.smk \

4. WGS Taxonomic & Functional Profiling (TaFeE-profile)

Kraken 2 classification, taxpasta matrices, host filtering, and HUMAnN 3 functional profiling of prepared paired-end reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-profile.smk \

Dry Run

Append -n to any command to perform a dry run:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \
-n

Output Results

Directory Structure

Results are written under results/{LIBRARY}/ (RE-RRSeq) or results/{RUN}/ (WGS).

QC Reports (00_QC/)

SeqKit statistics reports are generated at each processing stage to track read counts and quality:

FileDescription
seqkit.report.raw.txtRaw input read statistics
seqkit.report.bbduk.txtPost-BBDuk quality/entropy filtering
seqkit.report.prinseq.txtPost-PRINSEQ++ low-complexity filtering
seqkit.report.KDTrim.txtPost-KneadData Trimmomatic trimming
seqkit.report.KDTRF.txtPost-KneadData TRF repeat removal
seqkit.report.KDSILVA138.txtReads removed by SILVA 138.2 rRNA decontamination
seqkit.report.KDR.txtFinal decontaminated reads

Demultiplexed Reads (01_cutadapt/)

RE-RRSeq workflows only. Per-sample demultiplexed FASTQ files: {sample}.fastq.gz.

Read Masking (01_readMasking/)

Intermediate entropy-filtered (BBDuk) and low-complexity-filtered (PRINSEQ++) reads.

Decontaminated Reads (02_kneaddata/)

KneadData output reads after adapter trimming, TRF repeat removal, and SILVA rRNA decontamination:

  • RE-RRSeq:{sample}.fastq.gz (single-end)
  • WGS:{sample}.KDR.R1.fastq.gz, {sample}.KDR.R2.fastq.gz (paired-end)

Kraken 2 Classification (03_kraken2/)

FileDescription
{sample}.kraken2Kraken 2 report (used by taxpasta)
{sample}.k2.gzCompressed per-read classification output
{sample}.kraken2.classified*.fastq.gzClassified reads (used for downstream functional profiling in WGS)

Taxonomic Count Matrices

Taxpasta merges per-sample Kraken 2 reports into standardised count matrices at multiple taxonomic ranks:

RE-RRSeq (RE-RRSeq-TaFeE):

FileFormat
{LIBRARY}.kraken2.domain.counts.tsvTSV
{LIBRARY}.kraken2.phylum.counts.tsvTSV
{LIBRARY}.kraken2.class.counts.tsvTSV
{LIBRARY}.kraken2.order.counts.tsvTSV
{LIBRARY}.kraken2.family.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.tsvTSV
{LIBRARY}.kraken2.species.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.biomBIOM

WGS (TaFeE-profile):

FileFormat
kraken2.domain.tsvTSV
kraken2.phylum.tsvTSV
kraken2.class.tsvTSV
kraken2.order.tsvTSV
kraken2.family.tsvTSV
kraken2.genus.tsvTSV
kraken2.species.tsvTSV
kraken2.genus.biomBIOM

All TSV matrices include taxonomy ID, name, rank, and full lineage columns.

Host/Microbe Classification Proportions (04_k2_filtering/)

WGS only. Per-sample summary of read classification:

  • {sample}.classification.proportions.txt — counts of microbe, host, and unclassified reads

Functional Profiles (05_functional/)

WGS only. HUMAnN 3 functional profiling outputs (merged across all samples):

FileDescription
humann3_uniref50EC_microbial_pathabundance.rpk.tsvMetaCyc pathway abundance (RPK)
humann3_uniref50EC_microbial_pathcoverage.rpk.tsvMetaCyc pathway coverage
humann3_uniref50EC_microbial_genefamilies.rpk.tsvUniRef50 gene family abundance (RPK)
humann3_uniref50EC_microbial_genefamilies.rpk.KO.tsvGene families regrouped to KEGG Orthologs
humann3_uniref50EC_microbial_genefamilies.rpk.EC.tsvGene families regrouped to Enzyme Commission
humann3_uniref50EC_microbial_genefamilies.rpk.pfam.tsvGene families regrouped to Pfam
humann3_uniref50EC_microbial_genefamilies.rpk.EggNOG.tsvGene families regrouped to EggNOG
humann3_uniref50EC_microbial_genefamilies.rpk.cpm.QC.tsvGene families normalised to CPM
humann3_uniref50EC_microbial_pathabundance.rpk.cpm.QC.tsvPathway abundance normalised to CPM

Benchmarks

Runtime and resource usage for every rule are recorded under results/{LIBRARY or RUN}/benchmarks/.


Workflow DAG

RE-RRSeq (RE-RRSeq-TaFeE)

Raw RE-RRSeq FASTQ
→ cutadapt (demultiplex)
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData (Trimmomatic + TRF + SILVA rRNA removal)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)

WGS (TaFeE-prepare → TaFeE-profile)

Raw paired-end FASTQ
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData R1/R2 (Trimmomatic + TRF + SILVA rRNA removal)
→ SeqKit pair (read-pair repair)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)
→ Kraken 2 host filter
→ HUMAnN 3 (functional profiling)
→ Regroup (KO, EC, Pfam, EggNOG)
→ Normalise (CPM)

License

MIT License. Copyright (c) 2023-2024 Benjamin J Perry.

About

snakemake workflow for taxonomic profiling of biological sequence data

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - AgResearch/TaFeE: snakemake workflow for taxonomic profiling of biological sequence data · GitHub
Skip to content

Latest commit

History

209 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

TaFeE Banner

TaFeE — Taxonomic Feature Extraction from Microbiome Sequencing Data

A Snakemake workflow for quality control, taxonomic profiling, and functional annotation of biological sequence data (RE-RRSeq and WGS).


Overview

TaFeE provides modular Snakemake workflows for processing microbiome sequencing data from raw reads through to taxonomic count matrices and functional profiles. Three general-purpose workflow variants are included:

WorkflowSnakefileInputDescription
RE-RRSeq-TaFeEworkflow/RE-RRSeq-TaFeE.smkDemultiplexed RE-RRSeq single-end readsQC, read masking, host/rRNA decontamination, Kraken 2 taxonomy, and taxpasta count matrices for reduced-representation sequencing libraries
TaFeE-prepareworkflow/TaFeE-prepare.smkPaired-end WGS FASTQQC and host/rRNA decontamination of paired-end shotgun reads
TaFeE-profileworkflow/TaFeE-profile.smkKneadData-cleaned paired-end reads (output of TaFeE-prepare)Kraken 2 taxonomic profiling, taxpasta count matrices, host filtering, and HUMAnN 3 functional profiling

An additional helper workflow handles RE-RRSeq demultiplexing:

WorkflowSnakefileDescription
RE-RRSeq-TaFeE-demuxworkflow/RE-RRSeq-TaFeE-demux.smkDemultiplex RE-RRSeq libraries with cutadapt using barcodes

Dependencies

Snakemake & Conda

All workflows require Snakemake ≥ 8 with the cluster-generic executor plugin. A ready-made Conda environment specification is provided:

# workflow/env/conda.yamldependencies:
- conda
- snakedeploy
- snakefmt
- snakemake>=8
- snakemake-executor-plugin-cluster-generic

Create and activate the environment:

conda env create -f workflow/env/conda.yaml -n smk
conda activate smk

Bioinformatics Tool Environments

Each processing step uses its own Conda environment that Snakemake creates automatically via --use-conda. The environment YAML files are located in workflow/env/:

EnvironmentFileKey tools
BBMap 39.01env/bbmap-39.01.yamlbbduk.sh — adapter trimming, quality filtering, entropy masking
PRINSEQ++ 1.2.4env/prinseq-plus-plus-1.2.4.yamlprinseq++ — low-complexity filtering
KneadData 0.12env/kneaddata-0.12.yamlkneaddata — Trimmomatic trimming, TRF repeat removal, Bowtie 2 rRNA decontamination
SeqKit 2.4env/seqkit-2.4.yamlseqkit — FASTQ statistics and read-pair repair
pigz 2.6env/pigz-2.6.yamlpigz — parallel gzip compression
Kraken 2 2.1.3env/kraken2-2.1.3.yamlkraken2 — taxonomic classification
taxpasta 0.7.0env/taxpasta-0.7.0.yamltaxpasta — standardised taxonomic count matrix generation
HUMAnN 3.8env/human-3.8.yamlhumann3 — functional profiling (UniRef50 + MetaCyc)
cutadapt 4.4env/cutadapt-4.4.yamlcutadapt — RE-RRSeq demultiplexing

Reference Databases

The following databases must be downloaded or built and their paths set in config/config.yaml:

Config keyDescription
SILVASILVA 138.2 rRNA Bowtie 2 index directory for KneadData rRNA decontamination
K2INDEXKraken 2 index directory (must contain hash.k2d, opts.k2d, taxo.k2d)
TAXONOMYDirectory containing names.dmp and nodes.dmp for the Kraken 2 index (used by taxpasta)
HOSTSKraken 2 index of host genomes for host-read filtering (TaFeE-profile only)
UNIPROTDBHUMAnN 3 UniRef50/EC-filtered protein database directory (TaFeE-profile only)
TRIMMOMATICPath to a Trimmomatic installation (e.g. ~/.conda/envs/kneaddata/share/trimmomatic-0.39-2)
LINKFARMDirectory containing raw FASTQ symlinks for RE-RRSeq demultiplexing

Configuration

All pipeline parameters are set in config/config.yaml. Key parameters:

# Sequencing library identifier (RE-RRSeq workflows)LIBRARY: SQ1040# Run identifier (WGS workflows)RUN: wgs# Symlink farm for raw RE-RRSeq FASTQ filesLINKFARM: /path/to/fastq-link-farm# Reference database paths (see above)TRIMMOMATIC: "~/.conda/envs/kneaddata/share/trimmomatic-0.39-2"SILVA: /path/to/SILVA138.2K2INDEX: /path/to/kraken2_indexTAXONOMY: /path/to/kraken2_index/taxonomyHOSTS: /path/to/kraken2-hostsUNIPROTDB: /path/to/humann3/uniref50ECFilt

A SLURM cluster profile is provided at config/slurm_profiles/eRI/config.yaml for HPC submission.


Usage

All commands are run from the repository root directory.

1. RE-RRSeq Demultiplexing (RE-RRSeq-TaFeE-demux)

Demultiplex a RE-RRSeq library into per-sample FASTQ files using cutadapt:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE-demux.smk \

2. RE-RRSeq QC, Decontamination & Taxonomic Profiling (RE-RRSeq-TaFeE)

End-to-end processing of demultiplexed RE-RRSeq single-end reads — from read masking through Kraken 2 classification and taxpasta count matrices. Samples with fewer than 25,000 raw reads are automatically excluded.

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \

3. WGS Read Preparation (TaFeE-prepare)

QC and decontamination of paired-end WGS reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-prepare.smk \

4. WGS Taxonomic & Functional Profiling (TaFeE-profile)

Kraken 2 classification, taxpasta matrices, host filtering, and HUMAnN 3 functional profiling of prepared paired-end reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-profile.smk \

Dry Run

Append -n to any command to perform a dry run:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \
-n

Output Results

Directory Structure

Results are written under results/{LIBRARY}/ (RE-RRSeq) or results/{RUN}/ (WGS).

QC Reports (00_QC/)

SeqKit statistics reports are generated at each processing stage to track read counts and quality:

FileDescription
seqkit.report.raw.txtRaw input read statistics
seqkit.report.bbduk.txtPost-BBDuk quality/entropy filtering
seqkit.report.prinseq.txtPost-PRINSEQ++ low-complexity filtering
seqkit.report.KDTrim.txtPost-KneadData Trimmomatic trimming
seqkit.report.KDTRF.txtPost-KneadData TRF repeat removal
seqkit.report.KDSILVA138.txtReads removed by SILVA 138.2 rRNA decontamination
seqkit.report.KDR.txtFinal decontaminated reads

Demultiplexed Reads (01_cutadapt/)

RE-RRSeq workflows only. Per-sample demultiplexed FASTQ files: {sample}.fastq.gz.

Read Masking (01_readMasking/)

Intermediate entropy-filtered (BBDuk) and low-complexity-filtered (PRINSEQ++) reads.

Decontaminated Reads (02_kneaddata/)

KneadData output reads after adapter trimming, TRF repeat removal, and SILVA rRNA decontamination:

  • RE-RRSeq:{sample}.fastq.gz (single-end)
  • WGS:{sample}.KDR.R1.fastq.gz, {sample}.KDR.R2.fastq.gz (paired-end)

Kraken 2 Classification (03_kraken2/)

FileDescription
{sample}.kraken2Kraken 2 report (used by taxpasta)
{sample}.k2.gzCompressed per-read classification output
{sample}.kraken2.classified*.fastq.gzClassified reads (used for downstream functional profiling in WGS)

Taxonomic Count Matrices

Taxpasta merges per-sample Kraken 2 reports into standardised count matrices at multiple taxonomic ranks:

RE-RRSeq (RE-RRSeq-TaFeE):

FileFormat
{LIBRARY}.kraken2.domain.counts.tsvTSV
{LIBRARY}.kraken2.phylum.counts.tsvTSV
{LIBRARY}.kraken2.class.counts.tsvTSV
{LIBRARY}.kraken2.order.counts.tsvTSV
{LIBRARY}.kraken2.family.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.tsvTSV
{LIBRARY}.kraken2.species.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.biomBIOM

WGS (TaFeE-profile):

FileFormat
kraken2.domain.tsvTSV
kraken2.phylum.tsvTSV
kraken2.class.tsvTSV
kraken2.order.tsvTSV
kraken2.family.tsvTSV
kraken2.genus.tsvTSV
kraken2.species.tsvTSV
kraken2.genus.biomBIOM

All TSV matrices include taxonomy ID, name, rank, and full lineage columns.

Host/Microbe Classification Proportions (04_k2_filtering/)

WGS only. Per-sample summary of read classification:

  • {sample}.classification.proportions.txt — counts of microbe, host, and unclassified reads

Functional Profiles (05_functional/)

WGS only. HUMAnN 3 functional profiling outputs (merged across all samples):

FileDescription
humann3_uniref50EC_microbial_pathabundance.rpk.tsvMetaCyc pathway abundance (RPK)
humann3_uniref50EC_microbial_pathcoverage.rpk.tsvMetaCyc pathway coverage
humann3_uniref50EC_microbial_genefamilies.rpk.tsvUniRef50 gene family abundance (RPK)
humann3_uniref50EC_microbial_genefamilies.rpk.KO.tsvGene families regrouped to KEGG Orthologs
humann3_uniref50EC_microbial_genefamilies.rpk.EC.tsvGene families regrouped to Enzyme Commission
humann3_uniref50EC_microbial_genefamilies.rpk.pfam.tsvGene families regrouped to Pfam
humann3_uniref50EC_microbial_genefamilies.rpk.EggNOG.tsvGene families regrouped to EggNOG
humann3_uniref50EC_microbial_genefamilies.rpk.cpm.QC.tsvGene families normalised to CPM
humann3_uniref50EC_microbial_pathabundance.rpk.cpm.QC.tsvPathway abundance normalised to CPM

Benchmarks

Runtime and resource usage for every rule are recorded under results/{LIBRARY or RUN}/benchmarks/.


Workflow DAG

RE-RRSeq (RE-RRSeq-TaFeE)

Raw RE-RRSeq FASTQ
→ cutadapt (demultiplex)
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData (Trimmomatic + TRF + SILVA rRNA removal)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)

WGS (TaFeE-prepare → TaFeE-profile)

Raw paired-end FASTQ
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData R1/R2 (Trimmomatic + TRF + SILVA rRNA removal)
→ SeqKit pair (read-pair repair)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)
→ Kraken 2 host filter
→ HUMAnN 3 (functional profiling)
→ Regroup (KO, EC, Pfam, EggNOG)
→ Normalise (CPM)

License

MIT License. Copyright (c) 2023-2024 Benjamin J Perry.

About

snakemake workflow for taxonomic profiling of biological sequence data

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - AgResearch/TaFeE: snakemake workflow for taxonomic profiling of biological sequence data · GitHub
Skip to content

Latest commit

History

209 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

TaFeE Banner

TaFeE — Taxonomic Feature Extraction from Microbiome Sequencing Data

A Snakemake workflow for quality control, taxonomic profiling, and functional annotation of biological sequence data (RE-RRSeq and WGS).


Overview

TaFeE provides modular Snakemake workflows for processing microbiome sequencing data from raw reads through to taxonomic count matrices and functional profiles. Three general-purpose workflow variants are included:

WorkflowSnakefileInputDescription
RE-RRSeq-TaFeEworkflow/RE-RRSeq-TaFeE.smkDemultiplexed RE-RRSeq single-end readsQC, read masking, host/rRNA decontamination, Kraken 2 taxonomy, and taxpasta count matrices for reduced-representation sequencing libraries
TaFeE-prepareworkflow/TaFeE-prepare.smkPaired-end WGS FASTQQC and host/rRNA decontamination of paired-end shotgun reads
TaFeE-profileworkflow/TaFeE-profile.smkKneadData-cleaned paired-end reads (output of TaFeE-prepare)Kraken 2 taxonomic profiling, taxpasta count matrices, host filtering, and HUMAnN 3 functional profiling

An additional helper workflow handles RE-RRSeq demultiplexing:

WorkflowSnakefileDescription
RE-RRSeq-TaFeE-demuxworkflow/RE-RRSeq-TaFeE-demux.smkDemultiplex RE-RRSeq libraries with cutadapt using barcodes

Dependencies

Snakemake & Conda

All workflows require Snakemake ≥ 8 with the cluster-generic executor plugin. A ready-made Conda environment specification is provided:

# workflow/env/conda.yamldependencies:
- conda
- snakedeploy
- snakefmt
- snakemake>=8
- snakemake-executor-plugin-cluster-generic

Create and activate the environment:

conda env create -f workflow/env/conda.yaml -n smk
conda activate smk

Bioinformatics Tool Environments

Each processing step uses its own Conda environment that Snakemake creates automatically via --use-conda. The environment YAML files are located in workflow/env/:

EnvironmentFileKey tools
BBMap 39.01env/bbmap-39.01.yamlbbduk.sh — adapter trimming, quality filtering, entropy masking
PRINSEQ++ 1.2.4env/prinseq-plus-plus-1.2.4.yamlprinseq++ — low-complexity filtering
KneadData 0.12env/kneaddata-0.12.yamlkneaddata — Trimmomatic trimming, TRF repeat removal, Bowtie 2 rRNA decontamination
SeqKit 2.4env/seqkit-2.4.yamlseqkit — FASTQ statistics and read-pair repair
pigz 2.6env/pigz-2.6.yamlpigz — parallel gzip compression
Kraken 2 2.1.3env/kraken2-2.1.3.yamlkraken2 — taxonomic classification
taxpasta 0.7.0env/taxpasta-0.7.0.yamltaxpasta — standardised taxonomic count matrix generation
HUMAnN 3.8env/human-3.8.yamlhumann3 — functional profiling (UniRef50 + MetaCyc)
cutadapt 4.4env/cutadapt-4.4.yamlcutadapt — RE-RRSeq demultiplexing

Reference Databases

The following databases must be downloaded or built and their paths set in config/config.yaml:

Config keyDescription
SILVASILVA 138.2 rRNA Bowtie 2 index directory for KneadData rRNA decontamination
K2INDEXKraken 2 index directory (must contain hash.k2d, opts.k2d, taxo.k2d)
TAXONOMYDirectory containing names.dmp and nodes.dmp for the Kraken 2 index (used by taxpasta)
HOSTSKraken 2 index of host genomes for host-read filtering (TaFeE-profile only)
UNIPROTDBHUMAnN 3 UniRef50/EC-filtered protein database directory (TaFeE-profile only)
TRIMMOMATICPath to a Trimmomatic installation (e.g. ~/.conda/envs/kneaddata/share/trimmomatic-0.39-2)
LINKFARMDirectory containing raw FASTQ symlinks for RE-RRSeq demultiplexing

Configuration

All pipeline parameters are set in config/config.yaml. Key parameters:

# Sequencing library identifier (RE-RRSeq workflows)LIBRARY: SQ1040# Run identifier (WGS workflows)RUN: wgs# Symlink farm for raw RE-RRSeq FASTQ filesLINKFARM: /path/to/fastq-link-farm# Reference database paths (see above)TRIMMOMATIC: "~/.conda/envs/kneaddata/share/trimmomatic-0.39-2"SILVA: /path/to/SILVA138.2K2INDEX: /path/to/kraken2_indexTAXONOMY: /path/to/kraken2_index/taxonomyHOSTS: /path/to/kraken2-hostsUNIPROTDB: /path/to/humann3/uniref50ECFilt

A SLURM cluster profile is provided at config/slurm_profiles/eRI/config.yaml for HPC submission.


Usage

All commands are run from the repository root directory.

1. RE-RRSeq Demultiplexing (RE-RRSeq-TaFeE-demux)

Demultiplex a RE-RRSeq library into per-sample FASTQ files using cutadapt:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE-demux.smk \

2. RE-RRSeq QC, Decontamination & Taxonomic Profiling (RE-RRSeq-TaFeE)

End-to-end processing of demultiplexed RE-RRSeq single-end reads — from read masking through Kraken 2 classification and taxpasta count matrices. Samples with fewer than 25,000 raw reads are automatically excluded.

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \

3. WGS Read Preparation (TaFeE-prepare)

QC and decontamination of paired-end WGS reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-prepare.smk \

4. WGS Taxonomic & Functional Profiling (TaFeE-profile)

Kraken 2 classification, taxpasta matrices, host filtering, and HUMAnN 3 functional profiling of prepared paired-end reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-profile.smk \

Dry Run

Append -n to any command to perform a dry run:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \
-n

Output Results

Directory Structure

Results are written under results/{LIBRARY}/ (RE-RRSeq) or results/{RUN}/ (WGS).

QC Reports (00_QC/)

SeqKit statistics reports are generated at each processing stage to track read counts and quality:

FileDescription
seqkit.report.raw.txtRaw input read statistics
seqkit.report.bbduk.txtPost-BBDuk quality/entropy filtering
seqkit.report.prinseq.txtPost-PRINSEQ++ low-complexity filtering
seqkit.report.KDTrim.txtPost-KneadData Trimmomatic trimming
seqkit.report.KDTRF.txtPost-KneadData TRF repeat removal
seqkit.report.KDSILVA138.txtReads removed by SILVA 138.2 rRNA decontamination
seqkit.report.KDR.txtFinal decontaminated reads

Demultiplexed Reads (01_cutadapt/)

RE-RRSeq workflows only. Per-sample demultiplexed FASTQ files: {sample}.fastq.gz.

Read Masking (01_readMasking/)

Intermediate entropy-filtered (BBDuk) and low-complexity-filtered (PRINSEQ++) reads.

Decontaminated Reads (02_kneaddata/)

KneadData output reads after adapter trimming, TRF repeat removal, and SILVA rRNA decontamination:

  • RE-RRSeq:{sample}.fastq.gz (single-end)
  • WGS:{sample}.KDR.R1.fastq.gz, {sample}.KDR.R2.fastq.gz (paired-end)

Kraken 2 Classification (03_kraken2/)

FileDescription
{sample}.kraken2Kraken 2 report (used by taxpasta)
{sample}.k2.gzCompressed per-read classification output
{sample}.kraken2.classified*.fastq.gzClassified reads (used for downstream functional profiling in WGS)

Taxonomic Count Matrices

Taxpasta merges per-sample Kraken 2 reports into standardised count matrices at multiple taxonomic ranks:

RE-RRSeq (RE-RRSeq-TaFeE):

FileFormat
{LIBRARY}.kraken2.domain.counts.tsvTSV
{LIBRARY}.kraken2.phylum.counts.tsvTSV
{LIBRARY}.kraken2.class.counts.tsvTSV
{LIBRARY}.kraken2.order.counts.tsvTSV
{LIBRARY}.kraken2.family.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.tsvTSV
{LIBRARY}.kraken2.species.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.biomBIOM

WGS (TaFeE-profile):

FileFormat
kraken2.domain.tsvTSV
kraken2.phylum.tsvTSV
kraken2.class.tsvTSV
kraken2.order.tsvTSV
kraken2.family.tsvTSV
kraken2.genus.tsvTSV
kraken2.species.tsvTSV
kraken2.genus.biomBIOM

All TSV matrices include taxonomy ID, name, rank, and full lineage columns.

Host/Microbe Classification Proportions (04_k2_filtering/)

WGS only. Per-sample summary of read classification:

  • {sample}.classification.proportions.txt — counts of microbe, host, and unclassified reads

Functional Profiles (05_functional/)

WGS only. HUMAnN 3 functional profiling outputs (merged across all samples):

FileDescription
humann3_uniref50EC_microbial_pathabundance.rpk.tsvMetaCyc pathway abundance (RPK)
humann3_uniref50EC_microbial_pathcoverage.rpk.tsvMetaCyc pathway coverage
humann3_uniref50EC_microbial_genefamilies.rpk.tsvUniRef50 gene family abundance (RPK)
humann3_uniref50EC_microbial_genefamilies.rpk.KO.tsvGene families regrouped to KEGG Orthologs
humann3_uniref50EC_microbial_genefamilies.rpk.EC.tsvGene families regrouped to Enzyme Commission
humann3_uniref50EC_microbial_genefamilies.rpk.pfam.tsvGene families regrouped to Pfam
humann3_uniref50EC_microbial_genefamilies.rpk.EggNOG.tsvGene families regrouped to EggNOG
humann3_uniref50EC_microbial_genefamilies.rpk.cpm.QC.tsvGene families normalised to CPM
humann3_uniref50EC_microbial_pathabundance.rpk.cpm.QC.tsvPathway abundance normalised to CPM

Benchmarks

Runtime and resource usage for every rule are recorded under results/{LIBRARY or RUN}/benchmarks/.


Workflow DAG

RE-RRSeq (RE-RRSeq-TaFeE)

Raw RE-RRSeq FASTQ
→ cutadapt (demultiplex)
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData (Trimmomatic + TRF + SILVA rRNA removal)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)

WGS (TaFeE-prepare → TaFeE-profile)

Raw paired-end FASTQ
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData R1/R2 (Trimmomatic + TRF + SILVA rRNA removal)
→ SeqKit pair (read-pair repair)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)
→ Kraken 2 host filter
→ HUMAnN 3 (functional profiling)
→ Regroup (KO, EC, Pfam, EggNOG)
→ Normalise (CPM)

License

MIT License. Copyright (c) 2023-2024 Benjamin J Perry.

About

snakemake workflow for taxonomic profiling of biological sequence data

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' GitHub - AgResearch/TaFeE: snakemake workflow for taxonomic profiling of biological sequence data · GitHub
Skip to content

Latest commit

History

209 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

TaFeE Banner

TaFeE — Taxonomic Feature Extraction from Microbiome Sequencing Data

A Snakemake workflow for quality control, taxonomic profiling, and functional annotation of biological sequence data (RE-RRSeq and WGS).


Overview

TaFeE provides modular Snakemake workflows for processing microbiome sequencing data from raw reads through to taxonomic count matrices and functional profiles. Three general-purpose workflow variants are included:

WorkflowSnakefileInputDescription
RE-RRSeq-TaFeEworkflow/RE-RRSeq-TaFeE.smkDemultiplexed RE-RRSeq single-end readsQC, read masking, host/rRNA decontamination, Kraken 2 taxonomy, and taxpasta count matrices for reduced-representation sequencing libraries
TaFeE-prepareworkflow/TaFeE-prepare.smkPaired-end WGS FASTQQC and host/rRNA decontamination of paired-end shotgun reads
TaFeE-profileworkflow/TaFeE-profile.smkKneadData-cleaned paired-end reads (output of TaFeE-prepare)Kraken 2 taxonomic profiling, taxpasta count matrices, host filtering, and HUMAnN 3 functional profiling

An additional helper workflow handles RE-RRSeq demultiplexing:

WorkflowSnakefileDescription
RE-RRSeq-TaFeE-demuxworkflow/RE-RRSeq-TaFeE-demux.smkDemultiplex RE-RRSeq libraries with cutadapt using barcodes

Dependencies

Snakemake & Conda

All workflows require Snakemake ≥ 8 with the cluster-generic executor plugin. A ready-made Conda environment specification is provided:

# workflow/env/conda.yamldependencies:
- conda
- snakedeploy
- snakefmt
- snakemake>=8
- snakemake-executor-plugin-cluster-generic

Create and activate the environment:

conda env create -f workflow/env/conda.yaml -n smk
conda activate smk

Bioinformatics Tool Environments

Each processing step uses its own Conda environment that Snakemake creates automatically via --use-conda. The environment YAML files are located in workflow/env/:

EnvironmentFileKey tools
BBMap 39.01env/bbmap-39.01.yamlbbduk.sh — adapter trimming, quality filtering, entropy masking
PRINSEQ++ 1.2.4env/prinseq-plus-plus-1.2.4.yamlprinseq++ — low-complexity filtering
KneadData 0.12env/kneaddata-0.12.yamlkneaddata — Trimmomatic trimming, TRF repeat removal, Bowtie 2 rRNA decontamination
SeqKit 2.4env/seqkit-2.4.yamlseqkit — FASTQ statistics and read-pair repair
pigz 2.6env/pigz-2.6.yamlpigz — parallel gzip compression
Kraken 2 2.1.3env/kraken2-2.1.3.yamlkraken2 — taxonomic classification
taxpasta 0.7.0env/taxpasta-0.7.0.yamltaxpasta — standardised taxonomic count matrix generation
HUMAnN 3.8env/human-3.8.yamlhumann3 — functional profiling (UniRef50 + MetaCyc)
cutadapt 4.4env/cutadapt-4.4.yamlcutadapt — RE-RRSeq demultiplexing

Reference Databases

The following databases must be downloaded or built and their paths set in config/config.yaml:

Config keyDescription
SILVASILVA 138.2 rRNA Bowtie 2 index directory for KneadData rRNA decontamination
K2INDEXKraken 2 index directory (must contain hash.k2d, opts.k2d, taxo.k2d)
TAXONOMYDirectory containing names.dmp and nodes.dmp for the Kraken 2 index (used by taxpasta)
HOSTSKraken 2 index of host genomes for host-read filtering (TaFeE-profile only)
UNIPROTDBHUMAnN 3 UniRef50/EC-filtered protein database directory (TaFeE-profile only)
TRIMMOMATICPath to a Trimmomatic installation (e.g. ~/.conda/envs/kneaddata/share/trimmomatic-0.39-2)
LINKFARMDirectory containing raw FASTQ symlinks for RE-RRSeq demultiplexing

Configuration

All pipeline parameters are set in config/config.yaml. Key parameters:

# Sequencing library identifier (RE-RRSeq workflows)LIBRARY: SQ1040# Run identifier (WGS workflows)RUN: wgs# Symlink farm for raw RE-RRSeq FASTQ filesLINKFARM: /path/to/fastq-link-farm# Reference database paths (see above)TRIMMOMATIC: "~/.conda/envs/kneaddata/share/trimmomatic-0.39-2"SILVA: /path/to/SILVA138.2K2INDEX: /path/to/kraken2_indexTAXONOMY: /path/to/kraken2_index/taxonomyHOSTS: /path/to/kraken2-hostsUNIPROTDB: /path/to/humann3/uniref50ECFilt

A SLURM cluster profile is provided at config/slurm_profiles/eRI/config.yaml for HPC submission.


Usage

All commands are run from the repository root directory.

1. RE-RRSeq Demultiplexing (RE-RRSeq-TaFeE-demux)

Demultiplex a RE-RRSeq library into per-sample FASTQ files using cutadapt:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE-demux.smk \

2. RE-RRSeq QC, Decontamination & Taxonomic Profiling (RE-RRSeq-TaFeE)

End-to-end processing of demultiplexed RE-RRSeq single-end reads — from read masking through Kraken 2 classification and taxpasta count matrices. Samples with fewer than 25,000 raw reads are automatically excluded.

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \

3. WGS Read Preparation (TaFeE-prepare)

QC and decontamination of paired-end WGS reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-prepare.smk \

4. WGS Taxonomic & Functional Profiling (TaFeE-profile)

Kraken 2 classification, taxpasta matrices, host filtering, and HUMAnN 3 functional profiling of prepared paired-end reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-profile.smk \

Dry Run

Append -n to any command to perform a dry run:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \
-n

Output Results

Directory Structure

Results are written under results/{LIBRARY}/ (RE-RRSeq) or results/{RUN}/ (WGS).

QC Reports (00_QC/)

SeqKit statistics reports are generated at each processing stage to track read counts and quality:

FileDescription
seqkit.report.raw.txtRaw input read statistics
seqkit.report.bbduk.txtPost-BBDuk quality/entropy filtering
seqkit.report.prinseq.txtPost-PRINSEQ++ low-complexity filtering
seqkit.report.KDTrim.txtPost-KneadData Trimmomatic trimming
seqkit.report.KDTRF.txtPost-KneadData TRF repeat removal
seqkit.report.KDSILVA138.txtReads removed by SILVA 138.2 rRNA decontamination
seqkit.report.KDR.txtFinal decontaminated reads

Demultiplexed Reads (01_cutadapt/)

RE-RRSeq workflows only. Per-sample demultiplexed FASTQ files: {sample}.fastq.gz.

Read Masking (01_readMasking/)

Intermediate entropy-filtered (BBDuk) and low-complexity-filtered (PRINSEQ++) reads.

Decontaminated Reads (02_kneaddata/)

KneadData output reads after adapter trimming, TRF repeat removal, and SILVA rRNA decontamination:

  • RE-RRSeq:{sample}.fastq.gz (single-end)
  • WGS:{sample}.KDR.R1.fastq.gz, {sample}.KDR.R2.fastq.gz (paired-end)

Kraken 2 Classification (03_kraken2/)

FileDescription
{sample}.kraken2Kraken 2 report (used by taxpasta)
{sample}.k2.gzCompressed per-read classification output
{sample}.kraken2.classified*.fastq.gzClassified reads (used for downstream functional profiling in WGS)

Taxonomic Count Matrices

Taxpasta merges per-sample Kraken 2 reports into standardised count matrices at multiple taxonomic ranks:

RE-RRSeq (RE-RRSeq-TaFeE):

FileFormat
{LIBRARY}.kraken2.domain.counts.tsvTSV
{LIBRARY}.kraken2.phylum.counts.tsvTSV
{LIBRARY}.kraken2.class.counts.tsvTSV
{LIBRARY}.kraken2.order.counts.tsvTSV
{LIBRARY}.kraken2.family.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.tsvTSV
{LIBRARY}.kraken2.species.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.biomBIOM

WGS (TaFeE-profile):

FileFormat
kraken2.domain.tsvTSV
kraken2.phylum.tsvTSV
kraken2.class.tsvTSV
kraken2.order.tsvTSV
kraken2.family.tsvTSV
kraken2.genus.tsvTSV
kraken2.species.tsvTSV
kraken2.genus.biomBIOM

All TSV matrices include taxonomy ID, name, rank, and full lineage columns.

Host/Microbe Classification Proportions (04_k2_filtering/)

WGS only. Per-sample summary of read classification:

  • {sample}.classification.proportions.txt — counts of microbe, host, and unclassified reads

Functional Profiles (05_functional/)

WGS only. HUMAnN 3 functional profiling outputs (merged across all samples):

FileDescription
humann3_uniref50EC_microbial_pathabundance.rpk.tsvMetaCyc pathway abundance (RPK)
humann3_uniref50EC_microbial_pathcoverage.rpk.tsvMetaCyc pathway coverage
humann3_uniref50EC_microbial_genefamilies.rpk.tsvUniRef50 gene family abundance (RPK)
humann3_uniref50EC_microbial_genefamilies.rpk.KO.tsvGene families regrouped to KEGG Orthologs
humann3_uniref50EC_microbial_genefamilies.rpk.EC.tsvGene families regrouped to Enzyme Commission
humann3_uniref50EC_microbial_genefamilies.rpk.pfam.tsvGene families regrouped to Pfam
humann3_uniref50EC_microbial_genefamilies.rpk.EggNOG.tsvGene families regrouped to EggNOG
humann3_uniref50EC_microbial_genefamilies.rpk.cpm.QC.tsvGene families normalised to CPM
humann3_uniref50EC_microbial_pathabundance.rpk.cpm.QC.tsvPathway abundance normalised to CPM

Benchmarks

Runtime and resource usage for every rule are recorded under results/{LIBRARY or RUN}/benchmarks/.


Workflow DAG

RE-RRSeq (RE-RRSeq-TaFeE)

Raw RE-RRSeq FASTQ
→ cutadapt (demultiplex)
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData (Trimmomatic + TRF + SILVA rRNA removal)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)

WGS (TaFeE-prepare → TaFeE-profile)

Raw paired-end FASTQ
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData R1/R2 (Trimmomatic + TRF + SILVA rRNA removal)
→ SeqKit pair (read-pair repair)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)
→ Kraken 2 host filter
→ HUMAnN 3 (functional profiling)
→ Regroup (KO, EC, Pfam, EggNOG)
→ Normalise (CPM)

License

MIT License. Copyright (c) 2023-2024 Benjamin J Perry.

About

snakemake workflow for taxonomic profiling of biological sequence data

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - AgResearch/TaFeE: snakemake workflow for taxonomic profiling of biological sequence data · GitHub
Skip to content

Latest commit

History

209 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

TaFeE Banner

TaFeE — Taxonomic Feature Extraction from Microbiome Sequencing Data

A Snakemake workflow for quality control, taxonomic profiling, and functional annotation of biological sequence data (RE-RRSeq and WGS).


Overview

TaFeE provides modular Snakemake workflows for processing microbiome sequencing data from raw reads through to taxonomic count matrices and functional profiles. Three general-purpose workflow variants are included:

WorkflowSnakefileInputDescription
RE-RRSeq-TaFeEworkflow/RE-RRSeq-TaFeE.smkDemultiplexed RE-RRSeq single-end readsQC, read masking, host/rRNA decontamination, Kraken 2 taxonomy, and taxpasta count matrices for reduced-representation sequencing libraries
TaFeE-prepareworkflow/TaFeE-prepare.smkPaired-end WGS FASTQQC and host/rRNA decontamination of paired-end shotgun reads
TaFeE-profileworkflow/TaFeE-profile.smkKneadData-cleaned paired-end reads (output of TaFeE-prepare)Kraken 2 taxonomic profiling, taxpasta count matrices, host filtering, and HUMAnN 3 functional profiling

An additional helper workflow handles RE-RRSeq demultiplexing:

WorkflowSnakefileDescription
RE-RRSeq-TaFeE-demuxworkflow/RE-RRSeq-TaFeE-demux.smkDemultiplex RE-RRSeq libraries with cutadapt using barcodes

Dependencies

Snakemake & Conda

All workflows require Snakemake ≥ 8 with the cluster-generic executor plugin. A ready-made Conda environment specification is provided:

# workflow/env/conda.yamldependencies:
- conda
- snakedeploy
- snakefmt
- snakemake>=8
- snakemake-executor-plugin-cluster-generic

Create and activate the environment:

conda env create -f workflow/env/conda.yaml -n smk
conda activate smk

Bioinformatics Tool Environments

Each processing step uses its own Conda environment that Snakemake creates automatically via --use-conda. The environment YAML files are located in workflow/env/:

EnvironmentFileKey tools
BBMap 39.01env/bbmap-39.01.yamlbbduk.sh — adapter trimming, quality filtering, entropy masking
PRINSEQ++ 1.2.4env/prinseq-plus-plus-1.2.4.yamlprinseq++ — low-complexity filtering
KneadData 0.12env/kneaddata-0.12.yamlkneaddata — Trimmomatic trimming, TRF repeat removal, Bowtie 2 rRNA decontamination
SeqKit 2.4env/seqkit-2.4.yamlseqkit — FASTQ statistics and read-pair repair
pigz 2.6env/pigz-2.6.yamlpigz — parallel gzip compression
Kraken 2 2.1.3env/kraken2-2.1.3.yamlkraken2 — taxonomic classification
taxpasta 0.7.0env/taxpasta-0.7.0.yamltaxpasta — standardised taxonomic count matrix generation
HUMAnN 3.8env/human-3.8.yamlhumann3 — functional profiling (UniRef50 + MetaCyc)
cutadapt 4.4env/cutadapt-4.4.yamlcutadapt — RE-RRSeq demultiplexing

Reference Databases

The following databases must be downloaded or built and their paths set in config/config.yaml:

Config keyDescription
SILVASILVA 138.2 rRNA Bowtie 2 index directory for KneadData rRNA decontamination
K2INDEXKraken 2 index directory (must contain hash.k2d, opts.k2d, taxo.k2d)
TAXONOMYDirectory containing names.dmp and nodes.dmp for the Kraken 2 index (used by taxpasta)
HOSTSKraken 2 index of host genomes for host-read filtering (TaFeE-profile only)
UNIPROTDBHUMAnN 3 UniRef50/EC-filtered protein database directory (TaFeE-profile only)
TRIMMOMATICPath to a Trimmomatic installation (e.g. ~/.conda/envs/kneaddata/share/trimmomatic-0.39-2)
LINKFARMDirectory containing raw FASTQ symlinks for RE-RRSeq demultiplexing

Configuration

All pipeline parameters are set in config/config.yaml. Key parameters:

# Sequencing library identifier (RE-RRSeq workflows)LIBRARY: SQ1040# Run identifier (WGS workflows)RUN: wgs# Symlink farm for raw RE-RRSeq FASTQ filesLINKFARM: /path/to/fastq-link-farm# Reference database paths (see above)TRIMMOMATIC: "~/.conda/envs/kneaddata/share/trimmomatic-0.39-2"SILVA: /path/to/SILVA138.2K2INDEX: /path/to/kraken2_indexTAXONOMY: /path/to/kraken2_index/taxonomyHOSTS: /path/to/kraken2-hostsUNIPROTDB: /path/to/humann3/uniref50ECFilt

A SLURM cluster profile is provided at config/slurm_profiles/eRI/config.yaml for HPC submission.


Usage

All commands are run from the repository root directory.

1. RE-RRSeq Demultiplexing (RE-RRSeq-TaFeE-demux)

Demultiplex a RE-RRSeq library into per-sample FASTQ files using cutadapt:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE-demux.smk \

2. RE-RRSeq QC, Decontamination & Taxonomic Profiling (RE-RRSeq-TaFeE)

End-to-end processing of demultiplexed RE-RRSeq single-end reads — from read masking through Kraken 2 classification and taxpasta count matrices. Samples with fewer than 25,000 raw reads are automatically excluded.

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \

3. WGS Read Preparation (TaFeE-prepare)

QC and decontamination of paired-end WGS reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-prepare.smk \

4. WGS Taxonomic & Functional Profiling (TaFeE-profile)

Kraken 2 classification, taxpasta matrices, host filtering, and HUMAnN 3 functional profiling of prepared paired-end reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-profile.smk \

Dry Run

Append -n to any command to perform a dry run:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \
-n

Output Results

Directory Structure

Results are written under results/{LIBRARY}/ (RE-RRSeq) or results/{RUN}/ (WGS).

QC Reports (00_QC/)

SeqKit statistics reports are generated at each processing stage to track read counts and quality:

FileDescription
seqkit.report.raw.txtRaw input read statistics
seqkit.report.bbduk.txtPost-BBDuk quality/entropy filtering
seqkit.report.prinseq.txtPost-PRINSEQ++ low-complexity filtering
seqkit.report.KDTrim.txtPost-KneadData Trimmomatic trimming
seqkit.report.KDTRF.txtPost-KneadData TRF repeat removal
seqkit.report.KDSILVA138.txtReads removed by SILVA 138.2 rRNA decontamination
seqkit.report.KDR.txtFinal decontaminated reads

Demultiplexed Reads (01_cutadapt/)

RE-RRSeq workflows only. Per-sample demultiplexed FASTQ files: {sample}.fastq.gz.

Read Masking (01_readMasking/)

Intermediate entropy-filtered (BBDuk) and low-complexity-filtered (PRINSEQ++) reads.

Decontaminated Reads (02_kneaddata/)

KneadData output reads after adapter trimming, TRF repeat removal, and SILVA rRNA decontamination:

  • RE-RRSeq:{sample}.fastq.gz (single-end)
  • WGS:{sample}.KDR.R1.fastq.gz, {sample}.KDR.R2.fastq.gz (paired-end)

Kraken 2 Classification (03_kraken2/)

FileDescription
{sample}.kraken2Kraken 2 report (used by taxpasta)
{sample}.k2.gzCompressed per-read classification output
{sample}.kraken2.classified*.fastq.gzClassified reads (used for downstream functional profiling in WGS)

Taxonomic Count Matrices

Taxpasta merges per-sample Kraken 2 reports into standardised count matrices at multiple taxonomic ranks:

RE-RRSeq (RE-RRSeq-TaFeE):

FileFormat
{LIBRARY}.kraken2.domain.counts.tsvTSV
{LIBRARY}.kraken2.phylum.counts.tsvTSV
{LIBRARY}.kraken2.class.counts.tsvTSV
{LIBRARY}.kraken2.order.counts.tsvTSV
{LIBRARY}.kraken2.family.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.tsvTSV
{LIBRARY}.kraken2.species.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.biomBIOM

WGS (TaFeE-profile):

FileFormat
kraken2.domain.tsvTSV
kraken2.phylum.tsvTSV
kraken2.class.tsvTSV
kraken2.order.tsvTSV
kraken2.family.tsvTSV
kraken2.genus.tsvTSV
kraken2.species.tsvTSV
kraken2.genus.biomBIOM

All TSV matrices include taxonomy ID, name, rank, and full lineage columns.

Host/Microbe Classification Proportions (04_k2_filtering/)

WGS only. Per-sample summary of read classification:

  • {sample}.classification.proportions.txt — counts of microbe, host, and unclassified reads

Functional Profiles (05_functional/)

WGS only. HUMAnN 3 functional profiling outputs (merged across all samples):

FileDescription
humann3_uniref50EC_microbial_pathabundance.rpk.tsvMetaCyc pathway abundance (RPK)
humann3_uniref50EC_microbial_pathcoverage.rpk.tsvMetaCyc pathway coverage
humann3_uniref50EC_microbial_genefamilies.rpk.tsvUniRef50 gene family abundance (RPK)
humann3_uniref50EC_microbial_genefamilies.rpk.KO.tsvGene families regrouped to KEGG Orthologs
humann3_uniref50EC_microbial_genefamilies.rpk.EC.tsvGene families regrouped to Enzyme Commission
humann3_uniref50EC_microbial_genefamilies.rpk.pfam.tsvGene families regrouped to Pfam
humann3_uniref50EC_microbial_genefamilies.rpk.EggNOG.tsvGene families regrouped to EggNOG
humann3_uniref50EC_microbial_genefamilies.rpk.cpm.QC.tsvGene families normalised to CPM
humann3_uniref50EC_microbial_pathabundance.rpk.cpm.QC.tsvPathway abundance normalised to CPM

Benchmarks

Runtime and resource usage for every rule are recorded under results/{LIBRARY or RUN}/benchmarks/.


Workflow DAG

RE-RRSeq (RE-RRSeq-TaFeE)

Raw RE-RRSeq FASTQ
→ cutadapt (demultiplex)
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData (Trimmomatic + TRF + SILVA rRNA removal)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)

WGS (TaFeE-prepare → TaFeE-profile)

Raw paired-end FASTQ
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData R1/R2 (Trimmomatic + TRF + SILVA rRNA removal)
→ SeqKit pair (read-pair repair)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)
→ Kraken 2 host filter
→ HUMAnN 3 (functional profiling)
→ Regroup (KO, EC, Pfam, EggNOG)
→ Normalise (CPM)

License

MIT License. Copyright (c) 2023-2024 Benjamin J Perry.

About

snakemake workflow for taxonomic profiling of biological sequence data

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - AgResearch/TaFeE: snakemake workflow for taxonomic profiling of biological sequence data · GitHub
Skip to content

Latest commit

History

209 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

TaFeE Banner

TaFeE — Taxonomic Feature Extraction from Microbiome Sequencing Data

A Snakemake workflow for quality control, taxonomic profiling, and functional annotation of biological sequence data (RE-RRSeq and WGS).


Overview

TaFeE provides modular Snakemake workflows for processing microbiome sequencing data from raw reads through to taxonomic count matrices and functional profiles. Three general-purpose workflow variants are included:

WorkflowSnakefileInputDescription
RE-RRSeq-TaFeEworkflow/RE-RRSeq-TaFeE.smkDemultiplexed RE-RRSeq single-end readsQC, read masking, host/rRNA decontamination, Kraken 2 taxonomy, and taxpasta count matrices for reduced-representation sequencing libraries
TaFeE-prepareworkflow/TaFeE-prepare.smkPaired-end WGS FASTQQC and host/rRNA decontamination of paired-end shotgun reads
TaFeE-profileworkflow/TaFeE-profile.smkKneadData-cleaned paired-end reads (output of TaFeE-prepare)Kraken 2 taxonomic profiling, taxpasta count matrices, host filtering, and HUMAnN 3 functional profiling

An additional helper workflow handles RE-RRSeq demultiplexing:

WorkflowSnakefileDescription
RE-RRSeq-TaFeE-demuxworkflow/RE-RRSeq-TaFeE-demux.smkDemultiplex RE-RRSeq libraries with cutadapt using barcodes

Dependencies

Snakemake & Conda

All workflows require Snakemake ≥ 8 with the cluster-generic executor plugin. A ready-made Conda environment specification is provided:

# workflow/env/conda.yamldependencies:
- conda
- snakedeploy
- snakefmt
- snakemake>=8
- snakemake-executor-plugin-cluster-generic

Create and activate the environment:

conda env create -f workflow/env/conda.yaml -n smk
conda activate smk

Bioinformatics Tool Environments

Each processing step uses its own Conda environment that Snakemake creates automatically via --use-conda. The environment YAML files are located in workflow/env/:

EnvironmentFileKey tools
BBMap 39.01env/bbmap-39.01.yamlbbduk.sh — adapter trimming, quality filtering, entropy masking
PRINSEQ++ 1.2.4env/prinseq-plus-plus-1.2.4.yamlprinseq++ — low-complexity filtering
KneadData 0.12env/kneaddata-0.12.yamlkneaddata — Trimmomatic trimming, TRF repeat removal, Bowtie 2 rRNA decontamination
SeqKit 2.4env/seqkit-2.4.yamlseqkit — FASTQ statistics and read-pair repair
pigz 2.6env/pigz-2.6.yamlpigz — parallel gzip compression
Kraken 2 2.1.3env/kraken2-2.1.3.yamlkraken2 — taxonomic classification
taxpasta 0.7.0env/taxpasta-0.7.0.yamltaxpasta — standardised taxonomic count matrix generation
HUMAnN 3.8env/human-3.8.yamlhumann3 — functional profiling (UniRef50 + MetaCyc)
cutadapt 4.4env/cutadapt-4.4.yamlcutadapt — RE-RRSeq demultiplexing

Reference Databases

The following databases must be downloaded or built and their paths set in config/config.yaml:

Config keyDescription
SILVASILVA 138.2 rRNA Bowtie 2 index directory for KneadData rRNA decontamination
K2INDEXKraken 2 index directory (must contain hash.k2d, opts.k2d, taxo.k2d)
TAXONOMYDirectory containing names.dmp and nodes.dmp for the Kraken 2 index (used by taxpasta)
HOSTSKraken 2 index of host genomes for host-read filtering (TaFeE-profile only)
UNIPROTDBHUMAnN 3 UniRef50/EC-filtered protein database directory (TaFeE-profile only)
TRIMMOMATICPath to a Trimmomatic installation (e.g. ~/.conda/envs/kneaddata/share/trimmomatic-0.39-2)
LINKFARMDirectory containing raw FASTQ symlinks for RE-RRSeq demultiplexing

Configuration

All pipeline parameters are set in config/config.yaml. Key parameters:

# Sequencing library identifier (RE-RRSeq workflows)LIBRARY: SQ1040# Run identifier (WGS workflows)RUN: wgs# Symlink farm for raw RE-RRSeq FASTQ filesLINKFARM: /path/to/fastq-link-farm# Reference database paths (see above)TRIMMOMATIC: "~/.conda/envs/kneaddata/share/trimmomatic-0.39-2"SILVA: /path/to/SILVA138.2K2INDEX: /path/to/kraken2_indexTAXONOMY: /path/to/kraken2_index/taxonomyHOSTS: /path/to/kraken2-hostsUNIPROTDB: /path/to/humann3/uniref50ECFilt

A SLURM cluster profile is provided at config/slurm_profiles/eRI/config.yaml for HPC submission.


Usage

All commands are run from the repository root directory.

1. RE-RRSeq Demultiplexing (RE-RRSeq-TaFeE-demux)

Demultiplex a RE-RRSeq library into per-sample FASTQ files using cutadapt:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE-demux.smk \

2. RE-RRSeq QC, Decontamination & Taxonomic Profiling (RE-RRSeq-TaFeE)

End-to-end processing of demultiplexed RE-RRSeq single-end reads — from read masking through Kraken 2 classification and taxpasta count matrices. Samples with fewer than 25,000 raw reads are automatically excluded.

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \

3. WGS Read Preparation (TaFeE-prepare)

QC and decontamination of paired-end WGS reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-prepare.smk \

4. WGS Taxonomic & Functional Profiling (TaFeE-profile)

Kraken 2 classification, taxpasta matrices, host filtering, and HUMAnN 3 functional profiling of prepared paired-end reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-profile.smk \

Dry Run

Append -n to any command to perform a dry run:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \
-n

Output Results

Directory Structure

Results are written under results/{LIBRARY}/ (RE-RRSeq) or results/{RUN}/ (WGS).

QC Reports (00_QC/)

SeqKit statistics reports are generated at each processing stage to track read counts and quality:

FileDescription
seqkit.report.raw.txtRaw input read statistics
seqkit.report.bbduk.txtPost-BBDuk quality/entropy filtering
seqkit.report.prinseq.txtPost-PRINSEQ++ low-complexity filtering
seqkit.report.KDTrim.txtPost-KneadData Trimmomatic trimming
seqkit.report.KDTRF.txtPost-KneadData TRF repeat removal
seqkit.report.KDSILVA138.txtReads removed by SILVA 138.2 rRNA decontamination
seqkit.report.KDR.txtFinal decontaminated reads

Demultiplexed Reads (01_cutadapt/)

RE-RRSeq workflows only. Per-sample demultiplexed FASTQ files: {sample}.fastq.gz.

Read Masking (01_readMasking/)

Intermediate entropy-filtered (BBDuk) and low-complexity-filtered (PRINSEQ++) reads.

Decontaminated Reads (02_kneaddata/)

KneadData output reads after adapter trimming, TRF repeat removal, and SILVA rRNA decontamination:

  • RE-RRSeq:{sample}.fastq.gz (single-end)
  • WGS:{sample}.KDR.R1.fastq.gz, {sample}.KDR.R2.fastq.gz (paired-end)

Kraken 2 Classification (03_kraken2/)

FileDescription
{sample}.kraken2Kraken 2 report (used by taxpasta)
{sample}.k2.gzCompressed per-read classification output
{sample}.kraken2.classified*.fastq.gzClassified reads (used for downstream functional profiling in WGS)

Taxonomic Count Matrices

Taxpasta merges per-sample Kraken 2 reports into standardised count matrices at multiple taxonomic ranks:

RE-RRSeq (RE-RRSeq-TaFeE):

FileFormat
{LIBRARY}.kraken2.domain.counts.tsvTSV
{LIBRARY}.kraken2.phylum.counts.tsvTSV
{LIBRARY}.kraken2.class.counts.tsvTSV
{LIBRARY}.kraken2.order.counts.tsvTSV
{LIBRARY}.kraken2.family.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.tsvTSV
{LIBRARY}.kraken2.species.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.biomBIOM

WGS (TaFeE-profile):

FileFormat
kraken2.domain.tsvTSV
kraken2.phylum.tsvTSV
kraken2.class.tsvTSV
kraken2.order.tsvTSV
kraken2.family.tsvTSV
kraken2.genus.tsvTSV
kraken2.species.tsvTSV
kraken2.genus.biomBIOM

All TSV matrices include taxonomy ID, name, rank, and full lineage columns.

Host/Microbe Classification Proportions (04_k2_filtering/)

WGS only. Per-sample summary of read classification:

  • {sample}.classification.proportions.txt — counts of microbe, host, and unclassified reads

Functional Profiles (05_functional/)

WGS only. HUMAnN 3 functional profiling outputs (merged across all samples):

FileDescription
humann3_uniref50EC_microbial_pathabundance.rpk.tsvMetaCyc pathway abundance (RPK)
humann3_uniref50EC_microbial_pathcoverage.rpk.tsvMetaCyc pathway coverage
humann3_uniref50EC_microbial_genefamilies.rpk.tsvUniRef50 gene family abundance (RPK)
humann3_uniref50EC_microbial_genefamilies.rpk.KO.tsvGene families regrouped to KEGG Orthologs
humann3_uniref50EC_microbial_genefamilies.rpk.EC.tsvGene families regrouped to Enzyme Commission
humann3_uniref50EC_microbial_genefamilies.rpk.pfam.tsvGene families regrouped to Pfam
humann3_uniref50EC_microbial_genefamilies.rpk.EggNOG.tsvGene families regrouped to EggNOG
humann3_uniref50EC_microbial_genefamilies.rpk.cpm.QC.tsvGene families normalised to CPM
humann3_uniref50EC_microbial_pathabundance.rpk.cpm.QC.tsvPathway abundance normalised to CPM

Benchmarks

Runtime and resource usage for every rule are recorded under results/{LIBRARY or RUN}/benchmarks/.


Workflow DAG

RE-RRSeq (RE-RRSeq-TaFeE)

Raw RE-RRSeq FASTQ
→ cutadapt (demultiplex)
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData (Trimmomatic + TRF + SILVA rRNA removal)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)

WGS (TaFeE-prepare → TaFeE-profile)

Raw paired-end FASTQ
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData R1/R2 (Trimmomatic + TRF + SILVA rRNA removal)
→ SeqKit pair (read-pair repair)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)
→ Kraken 2 host filter
→ HUMAnN 3 (functional profiling)
→ Regroup (KO, EC, Pfam, EggNOG)
→ Normalise (CPM)

License

MIT License. Copyright (c) 2023-2024 Benjamin J Perry.

About

snakemake workflow for taxonomic profiling of biological sequence data

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); GitHub - AgResearch/TaFeE: snakemake workflow for taxonomic profiling of biological sequence data · GitHub
Skip to content

Latest commit

History

209 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

TaFeE Banner

TaFeE — Taxonomic Feature Extraction from Microbiome Sequencing Data

A Snakemake workflow for quality control, taxonomic profiling, and functional annotation of biological sequence data (RE-RRSeq and WGS).


Overview

TaFeE provides modular Snakemake workflows for processing microbiome sequencing data from raw reads through to taxonomic count matrices and functional profiles. Three general-purpose workflow variants are included:

WorkflowSnakefileInputDescription
RE-RRSeq-TaFeEworkflow/RE-RRSeq-TaFeE.smkDemultiplexed RE-RRSeq single-end readsQC, read masking, host/rRNA decontamination, Kraken 2 taxonomy, and taxpasta count matrices for reduced-representation sequencing libraries
TaFeE-prepareworkflow/TaFeE-prepare.smkPaired-end WGS FASTQQC and host/rRNA decontamination of paired-end shotgun reads
TaFeE-profileworkflow/TaFeE-profile.smkKneadData-cleaned paired-end reads (output of TaFeE-prepare)Kraken 2 taxonomic profiling, taxpasta count matrices, host filtering, and HUMAnN 3 functional profiling

An additional helper workflow handles RE-RRSeq demultiplexing:

WorkflowSnakefileDescription
RE-RRSeq-TaFeE-demuxworkflow/RE-RRSeq-TaFeE-demux.smkDemultiplex RE-RRSeq libraries with cutadapt using barcodes

Dependencies

Snakemake & Conda

All workflows require Snakemake ≥ 8 with the cluster-generic executor plugin. A ready-made Conda environment specification is provided:

# workflow/env/conda.yamldependencies:
- conda
- snakedeploy
- snakefmt
- snakemake>=8
- snakemake-executor-plugin-cluster-generic

Create and activate the environment:

conda env create -f workflow/env/conda.yaml -n smk
conda activate smk

Bioinformatics Tool Environments

Each processing step uses its own Conda environment that Snakemake creates automatically via --use-conda. The environment YAML files are located in workflow/env/:

EnvironmentFileKey tools
BBMap 39.01env/bbmap-39.01.yamlbbduk.sh — adapter trimming, quality filtering, entropy masking
PRINSEQ++ 1.2.4env/prinseq-plus-plus-1.2.4.yamlprinseq++ — low-complexity filtering
KneadData 0.12env/kneaddata-0.12.yamlkneaddata — Trimmomatic trimming, TRF repeat removal, Bowtie 2 rRNA decontamination
SeqKit 2.4env/seqkit-2.4.yamlseqkit — FASTQ statistics and read-pair repair
pigz 2.6env/pigz-2.6.yamlpigz — parallel gzip compression
Kraken 2 2.1.3env/kraken2-2.1.3.yamlkraken2 — taxonomic classification
taxpasta 0.7.0env/taxpasta-0.7.0.yamltaxpasta — standardised taxonomic count matrix generation
HUMAnN 3.8env/human-3.8.yamlhumann3 — functional profiling (UniRef50 + MetaCyc)
cutadapt 4.4env/cutadapt-4.4.yamlcutadapt — RE-RRSeq demultiplexing

Reference Databases

The following databases must be downloaded or built and their paths set in config/config.yaml:

Config keyDescription
SILVASILVA 138.2 rRNA Bowtie 2 index directory for KneadData rRNA decontamination
K2INDEXKraken 2 index directory (must contain hash.k2d, opts.k2d, taxo.k2d)
TAXONOMYDirectory containing names.dmp and nodes.dmp for the Kraken 2 index (used by taxpasta)
HOSTSKraken 2 index of host genomes for host-read filtering (TaFeE-profile only)
UNIPROTDBHUMAnN 3 UniRef50/EC-filtered protein database directory (TaFeE-profile only)
TRIMMOMATICPath to a Trimmomatic installation (e.g. ~/.conda/envs/kneaddata/share/trimmomatic-0.39-2)
LINKFARMDirectory containing raw FASTQ symlinks for RE-RRSeq demultiplexing

Configuration

All pipeline parameters are set in config/config.yaml. Key parameters:

# Sequencing library identifier (RE-RRSeq workflows)LIBRARY: SQ1040# Run identifier (WGS workflows)RUN: wgs# Symlink farm for raw RE-RRSeq FASTQ filesLINKFARM: /path/to/fastq-link-farm# Reference database paths (see above)TRIMMOMATIC: "~/.conda/envs/kneaddata/share/trimmomatic-0.39-2"SILVA: /path/to/SILVA138.2K2INDEX: /path/to/kraken2_indexTAXONOMY: /path/to/kraken2_index/taxonomyHOSTS: /path/to/kraken2-hostsUNIPROTDB: /path/to/humann3/uniref50ECFilt

A SLURM cluster profile is provided at config/slurm_profiles/eRI/config.yaml for HPC submission.


Usage

All commands are run from the repository root directory.

1. RE-RRSeq Demultiplexing (RE-RRSeq-TaFeE-demux)

Demultiplex a RE-RRSeq library into per-sample FASTQ files using cutadapt:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE-demux.smk \

2. RE-RRSeq QC, Decontamination & Taxonomic Profiling (RE-RRSeq-TaFeE)

End-to-end processing of demultiplexed RE-RRSeq single-end reads — from read masking through Kraken 2 classification and taxpasta count matrices. Samples with fewer than 25,000 raw reads are automatically excluded.

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \

3. WGS Read Preparation (TaFeE-prepare)

QC and decontamination of paired-end WGS reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-prepare.smk \

4. WGS Taxonomic & Functional Profiling (TaFeE-profile)

Kraken 2 classification, taxpasta matrices, host filtering, and HUMAnN 3 functional profiling of prepared paired-end reads:

snakemake --profile config/slurm_profiles/eRI \
--config RUN=wgs \
--snakefile workflow/TaFeE-profile.smk \

Dry Run

Append -n to any command to perform a dry run:

snakemake --profile config/slurm_profiles/eRI \
--config LIBRARY=SQ1040 \
--snakefile workflow/RE-RRSeq-TaFeE.smk \
-n

Output Results

Directory Structure

Results are written under results/{LIBRARY}/ (RE-RRSeq) or results/{RUN}/ (WGS).

QC Reports (00_QC/)

SeqKit statistics reports are generated at each processing stage to track read counts and quality:

FileDescription
seqkit.report.raw.txtRaw input read statistics
seqkit.report.bbduk.txtPost-BBDuk quality/entropy filtering
seqkit.report.prinseq.txtPost-PRINSEQ++ low-complexity filtering
seqkit.report.KDTrim.txtPost-KneadData Trimmomatic trimming
seqkit.report.KDTRF.txtPost-KneadData TRF repeat removal
seqkit.report.KDSILVA138.txtReads removed by SILVA 138.2 rRNA decontamination
seqkit.report.KDR.txtFinal decontaminated reads

Demultiplexed Reads (01_cutadapt/)

RE-RRSeq workflows only. Per-sample demultiplexed FASTQ files: {sample}.fastq.gz.

Read Masking (01_readMasking/)

Intermediate entropy-filtered (BBDuk) and low-complexity-filtered (PRINSEQ++) reads.

Decontaminated Reads (02_kneaddata/)

KneadData output reads after adapter trimming, TRF repeat removal, and SILVA rRNA decontamination:

  • RE-RRSeq:{sample}.fastq.gz (single-end)
  • WGS:{sample}.KDR.R1.fastq.gz, {sample}.KDR.R2.fastq.gz (paired-end)

Kraken 2 Classification (03_kraken2/)

FileDescription
{sample}.kraken2Kraken 2 report (used by taxpasta)
{sample}.k2.gzCompressed per-read classification output
{sample}.kraken2.classified*.fastq.gzClassified reads (used for downstream functional profiling in WGS)

Taxonomic Count Matrices

Taxpasta merges per-sample Kraken 2 reports into standardised count matrices at multiple taxonomic ranks:

RE-RRSeq (RE-RRSeq-TaFeE):

FileFormat
{LIBRARY}.kraken2.domain.counts.tsvTSV
{LIBRARY}.kraken2.phylum.counts.tsvTSV
{LIBRARY}.kraken2.class.counts.tsvTSV
{LIBRARY}.kraken2.order.counts.tsvTSV
{LIBRARY}.kraken2.family.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.tsvTSV
{LIBRARY}.kraken2.species.counts.tsvTSV
{LIBRARY}.kraken2.genus.counts.biomBIOM

WGS (TaFeE-profile):

FileFormat
kraken2.domain.tsvTSV
kraken2.phylum.tsvTSV
kraken2.class.tsvTSV
kraken2.order.tsvTSV
kraken2.family.tsvTSV
kraken2.genus.tsvTSV
kraken2.species.tsvTSV
kraken2.genus.biomBIOM

All TSV matrices include taxonomy ID, name, rank, and full lineage columns.

Host/Microbe Classification Proportions (04_k2_filtering/)

WGS only. Per-sample summary of read classification:

  • {sample}.classification.proportions.txt — counts of microbe, host, and unclassified reads

Functional Profiles (05_functional/)

WGS only. HUMAnN 3 functional profiling outputs (merged across all samples):

FileDescription
humann3_uniref50EC_microbial_pathabundance.rpk.tsvMetaCyc pathway abundance (RPK)
humann3_uniref50EC_microbial_pathcoverage.rpk.tsvMetaCyc pathway coverage
humann3_uniref50EC_microbial_genefamilies.rpk.tsvUniRef50 gene family abundance (RPK)
humann3_uniref50EC_microbial_genefamilies.rpk.KO.tsvGene families regrouped to KEGG Orthologs
humann3_uniref50EC_microbial_genefamilies.rpk.EC.tsvGene families regrouped to Enzyme Commission
humann3_uniref50EC_microbial_genefamilies.rpk.pfam.tsvGene families regrouped to Pfam
humann3_uniref50EC_microbial_genefamilies.rpk.EggNOG.tsvGene families regrouped to EggNOG
humann3_uniref50EC_microbial_genefamilies.rpk.cpm.QC.tsvGene families normalised to CPM
humann3_uniref50EC_microbial_pathabundance.rpk.cpm.QC.tsvPathway abundance normalised to CPM

Benchmarks

Runtime and resource usage for every rule are recorded under results/{LIBRARY or RUN}/benchmarks/.


Workflow DAG

RE-RRSeq (RE-RRSeq-TaFeE)

Raw RE-RRSeq FASTQ
→ cutadapt (demultiplex)
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData (Trimmomatic + TRF + SILVA rRNA removal)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)

WGS (TaFeE-prepare → TaFeE-profile)

Raw paired-end FASTQ
→ BBDuk (entropy/quality filter)
→ PRINSEQ++ (low-complexity filter)
→ KneadData R1/R2 (Trimmomatic + TRF + SILVA rRNA removal)
→ SeqKit pair (read-pair repair)
→ Kraken 2 (taxonomic classification)
→ taxpasta (count matrices at domain → species)
→ Kraken 2 host filter
→ HUMAnN 3 (functional profiling)
→ Regroup (KO, EC, Pfam, EggNOG)
→ Normalise (CPM)

License

MIT License. Copyright (c) 2023-2024 Benjamin J Perry.

About

snakemake workflow for taxonomic profiling of biological sequence data

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages