How creeveylab/pipeline-holoruminant-meta works
This repository is a Snakemake metagenomics workflow, with a Kelvin2/HPC-focused fork setup. Users configure or bootstrap a project, then run analysis modules on sequencing reads through read-, contig-, and MAG-based analyses, with quantification and reports as additional outputs. The README documents the broad module flow and major capabilities; source excerpts here are limited to utility scripts, so internal rule-level calls and data handoffs are not represented. Kelvin2 resource profiles and shared stores are shown as deployment integrations, not workflow stages.
Main entry points: Snakefile Workflow runner · assemble Assembly and binning · contig_annotate Contig annotation · bootstrap_project.sh Project bootstrap
Components 21
Run setup
- Workflow runner
workflow/Snakefile - Project bootstrap
workflow/scripts/bootstrap_project.sh - Pipeline configuration
config - SLURM job status
workflow/scripts/slurm_status.py
Read analysis
- Read preprocessing
workflow/rules/preprocess - Read checks
workflow/rules/reads - Read annotation
workflow/rules/read_annotate - Bracken estimation
workflow/scripts/bracken_est_abundance.py
Genome analysis
- Assembly and binning
workflow/rules/assemble - Contig annotation
workflow/rules/contig_annotate - MAG annotation
workflow/rules/mag_annotate - Assembly renaming
workflow/scripts/rename_provided_assemblies.py - MAGScoT FASTA formatting
workflow/scripts/reformat_fasta_magscot.py - Annotation formatting
workflow/scripts/fix_annotations.py
Outputs and resources
- Abundance quantification
workflow/rules/quantify - Host references
workflow/rules/reference - Module reports
workflow/rules/report - Reference/database store
- Container image cache
Other components
- Pipeline user
- Kelvin2 SLURM
Connections 23
- Pipeline user → Project bootstrap: bootstraps project
README.md - Pipeline user → Workflow runner: launches workflow
README.md - Project bootstrap → Reference/database store: wires shared store
README.md - Project bootstrap → Container image cache: wires cache
README.md - Pipeline configuration → Workflow runner: configures run
- Workflow runner → Read preprocessing: runs module
README.md - Read preprocessing → Read checks: feeds read workflow
- Read checks → Read annotation: feeds read analysis
- Read annotation → Assembly and binning: feeds assembly
- Assembly and binning → Contig annotation: feeds contig analysis
- Contig annotation → MAG annotation: feeds MAG analysis
- Workflow runner → Abundance quantification: runs module
README.md - Workflow runner → Host references: runs module
README.md - Workflow runner → Module reports: runs module
README.md - Workflow runner → Assembly and binning: runs module
README.md - Workflow runner → Contig annotation: runs module
README.md - Workflow runner → MAG annotation: runs module
README.md - Kelvin2 SLURM → Workflow runner: schedules jobs
README.md - SLURM job status → Kelvin2 SLURM: queries job status
workflow/scripts/slurm_status.py - Read annotation → Bracken estimation: uses estimator
workflow/scripts/bracken_est_abundance.py - Assembly and binning → Assembly renaming: renames assemblies
- MAG annotation → MAGScoT FASTA formatting: formats FASTA
- Contig annotation → Annotation formatting: fixes annotations