# creeveylab/pipeline-holoruminant-meta architecture

> Architecture diagram of the GitHub repository creeveylab/pipeline-holoruminant-meta, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/creeveylab/pipeline-holoruminant-meta
- Repository: https://github.com/creeveylab/pipeline-holoruminant-meta

## Overview

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: [`workflow/Snakefile`](https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/Snakefile) (Workflow runner), [`workflow/rules/assemble`](https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/assemble) (Assembly and binning), [`workflow/rules/contig_annotate`](https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/contig_annotate) (Contig annotation), [`workflow/scripts/bootstrap_project.sh`](https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/bootstrap_project.sh) (Project bootstrap)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Run setup"]
  node_launcher["Workflow runner"]
  node_project_setup["Project bootstrap"]
  node_configuration["Pipeline configuration"]
  node_slurm_status["SLURM job status<br/>[slurm_status.py]"]
end

subgraph group_reads["Read analysis"]
  node_read_prep["Read preprocessing"]
  node_read_qc["Read checks"]
  node_read_annotate["Read annotation"]
  node_bracken_estimation["Bracken estimation"]
end

subgraph group_genomes["Genome analysis"]
  node_assembly["Assembly and binning"]
  node_contig_annotate["Contig annotation"]
  node_mag_annotate["MAG annotation"]
  node_assembly_name["Assembly renaming"]
  node_magscot_fasta["MAGScoT FASTA formatting"]
  node_annotation_fix["Annotation formatting<br/>[fix_annotations.py]"]
end

subgraph group_outputs["Outputs and resources"]
  node_quantify["Abundance quantification"]
  node_reference["Host references"]
  node_report["Module reports"]
  node_database_store[("Reference/database store")]
  node_container_cache[("Container image cache")]
end

node_user(("Pipeline user"))
node_slurm{{"Kelvin2 SLURM"}}

node_user -->|"bootstraps project"| node_project_setup
node_user -->|"launches workflow"| node_launcher
node_project_setup -->|"wires shared store"| node_database_store
node_project_setup -->|"wires cache"| node_container_cache
node_configuration -.->|"configures run"| node_launcher
node_launcher -->|"runs module"| node_read_prep
node_read_prep -.->|"feeds read workflow"| node_read_qc
node_read_qc -.->|"feeds read analysis"| node_read_annotate
node_read_annotate -.->|"feeds assembly"| node_assembly
node_assembly -.->|"feeds contig analysis"| node_contig_annotate
node_contig_annotate -.->|"feeds MAG analysis"| node_mag_annotate
node_launcher -->|"runs module"| node_quantify
node_launcher -->|"runs module"| node_reference
node_launcher -->|"runs module"| node_report
node_launcher -->|"runs module"| node_assembly
node_launcher -->|"runs module"| node_contig_annotate
node_launcher -->|"runs module"| node_mag_annotate
node_slurm -->|"schedules jobs"| node_launcher
node_slurm_status -->|"queries job status"| node_slurm
node_read_annotate -->|"uses estimator"| node_bracken_estimation
node_assembly -.->|"renames assemblies"| node_assembly_name
node_mag_annotate -.->|"formats FASTA"| node_magscot_fasta
node_contig_annotate -.->|"fixes annotations"| node_annotation_fix

click node_launcher "https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/Snakefile"
click node_project_setup "https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/bootstrap_project.sh"
click node_configuration "https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/config"
click node_read_prep "https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/preprocess"
click node_read_qc "https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/reads"
click node_read_annotate "https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/read_annotate"
click node_assembly "https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/assemble"
click node_contig_annotate "https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/contig_annotate"
click node_mag_annotate "https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/mag_annotate"
click node_quantify "https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/quantify"
click node_reference "https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/reference"
click node_report "https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/report"
click node_bracken_estimation "https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/bracken_est_abundance.py"
click node_assembly_name "https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/rename_provided_assemblies.py"
click node_magscot_fasta "https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/reformat_fasta_magscot.py"
click node_annotation_fix "https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/fix_annotations.py"
click node_slurm_status "https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/slurm_status.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_launcher,node_project_setup,node_configuration,node_slurm_status,node_user toneBlue
class node_read_prep,node_read_qc,node_read_annotate,node_bracken_estimation toneAmber
class node_assembly,node_contig_annotate,node_mag_annotate,node_assembly_name,node_magscot_fasta,node_annotation_fix toneMint
class node_quantify,node_reference,node_report,node_database_store,node_container_cache toneRose
class node_slurm toneIndigo
```

## Components

### Run setup

- [Workflow runner](https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/Snakefile): `workflow/Snakefile`
- [Project bootstrap](https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/bootstrap_project.sh): `workflow/scripts/bootstrap_project.sh`
- [Pipeline configuration](https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/config): `config`
- [SLURM job status](https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/slurm_status.py): `workflow/scripts/slurm_status.py`

### Read analysis

- [Read preprocessing](https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/preprocess): `workflow/rules/preprocess`
- [Read checks](https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/reads): `workflow/rules/reads`
- [Read annotation](https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/read_annotate): `workflow/rules/read_annotate`
- [Bracken estimation](https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/bracken_est_abundance.py): `workflow/scripts/bracken_est_abundance.py`

### Genome analysis

- [Assembly and binning](https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/assemble): `workflow/rules/assemble`
- [Contig annotation](https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/contig_annotate): `workflow/rules/contig_annotate`
- [MAG annotation](https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/mag_annotate): `workflow/rules/mag_annotate`
- [Assembly renaming](https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/rename_provided_assemblies.py): `workflow/scripts/rename_provided_assemblies.py`
- [MAGScoT FASTA formatting](https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/reformat_fasta_magscot.py): `workflow/scripts/reformat_fasta_magscot.py`
- [Annotation formatting](https://github.com/creeveylab/pipeline-holoruminant-meta/blob/main/workflow/scripts/fix_annotations.py): `workflow/scripts/fix_annotations.py`

### Outputs and resources

- [Abundance quantification](https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/quantify): `workflow/rules/quantify`
- [Host references](https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/reference): `workflow/rules/reference`
- [Module reports](https://github.com/creeveylab/pipeline-holoruminant-meta/tree/main/workflow/rules/report): `workflow/rules/report`
- **Reference/database store**
- **Container image cache**

### Other components

- **Pipeline user**
- **Kelvin2 SLURM**

## Connections

- Pipeline user → Project bootstrap: bootstraps project (evidence: `README.md`)
- Pipeline user → Workflow runner: launches workflow (evidence: `README.md`)
- Project bootstrap → Reference/database store: wires shared store (evidence: `README.md`)
- Project bootstrap → Container image cache: wires cache (evidence: `README.md`)
- Pipeline configuration → Workflow runner: configures run
- Workflow runner → Read preprocessing: runs module (evidence: `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 (evidence: `README.md`)
- Workflow runner → Host references: runs module (evidence: `README.md`)
- Workflow runner → Module reports: runs module (evidence: `README.md`)
- Workflow runner → Assembly and binning: runs module (evidence: `README.md`)
- Workflow runner → Contig annotation: runs module (evidence: `README.md`)
- Workflow runner → MAG annotation: runs module (evidence: `README.md`)
- Kelvin2 SLURM → Workflow runner: schedules jobs (evidence: `README.md`)
- SLURM job status → Kelvin2 SLURM: queries job status (evidence: `workflow/scripts/slurm_status.py`)
- Read annotation → Bracken estimation: uses estimator (evidence: `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
