# green-lab-mdacc/capp_seq_pipeline architecture

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

- Interactive diagram: https://gitdiagram.com/green-lab-mdacc/capp_seq_pipeline
- Repository: https://github.com/green-lab-mdacc/capp_seq_pipeline

## Overview

CAPP_SEQ_pipeline processes paired-end FASTQ reads through UMI consensus generation, variant calling and read enumeration, then produces a filtered CSV. The README documents these stages and their tools; the pipeline shell script is present in the tree but was not excerpted, so the graph uses README evidence for workflow relationships. The optional PoN filter is documented, though the sampled post-processing script sets it disabled.

Main entry points: [`scripts/capp_seq_pipeline.sh`](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh) (Pipeline runner), [`scripts/seq_post_process.py`](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/seq_post_process.py) (Variant merging)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_prep["Read preparation"]
  node_pipeline["Pipeline runner"]
  node_qc["FASTQ quality"]
  node_unaligned["BAM conversion"]
  node_umi["UMI extraction"]
  node_alignment["Read alignment"]
end

subgraph group_consensus["UMI consensus"]
  node_grouping["UMI grouping"]
  node_consensus_calls["Consensus calling"]
  node_consensus_filter["Consensus filtering"]
end

subgraph group_variants["Variant analysis"]
  node_metrics["Capture metrics"]
  node_variant_calling["Variant calling"]
  node_enumeration["Read enumeration"]
end

subgraph group_results["Results"]
  node_postprocess["Variant merging"]
  node_pon["PoN filtering"]
  node_csv["CSV output"]
end

node_researcher(("Sample inputs"))
node_bio_tools["Bioinformatics tools"]

node_researcher -->|"provides reads"| node_pipeline
node_pipeline -->|"runs"| node_qc
node_pipeline -->|"converts reads"| node_unaligned
node_pipeline -->|"extracts UMIs"| node_umi
node_pipeline -->|"aligns reads"| node_alignment
node_pipeline -->|"groups reads"| node_grouping
node_pipeline -->|"calls consensus"| node_consensus_calls
node_pipeline -->|"filters reads"| node_consensus_filter
node_pipeline -->|"computes metrics"| node_metrics
node_pipeline -->|"calls variants"| node_variant_calling
node_pipeline -->|"enumerates reads"| node_enumeration
node_pipeline -->|"runs script"| node_postprocess
node_bio_tools -->|"runs FastQC"| node_qc
node_bio_tools -->|"converts FASTQ"| node_unaligned
node_bio_tools -->|"extracts UMIs"| node_umi
node_bio_tools -->|"aligns and merges"| node_alignment
node_bio_tools -->|"groups families"| node_grouping
node_bio_tools -->|"calls consensus"| node_consensus_calls
node_bio_tools -->|"filters consensus"| node_consensus_filter
node_bio_tools -->|"collects metrics"| node_metrics
node_bio_tools -->|"calls variants"| node_variant_calling
node_bio_tools -->|"counts reads"| node_enumeration
node_postprocess -.->|"optionally filters"| node_pon
node_postprocess -->|"writes CSV"| node_csv

click node_pipeline "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh"
click node_qc "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh"
click node_unaligned "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh"
click node_umi "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh"
click node_alignment "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh"
click node_grouping "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh"
click node_consensus_calls "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh"
click node_consensus_filter "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh"
click node_metrics "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh"
click node_variant_calling "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh"
click node_enumeration "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh"
click node_postprocess "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/seq_post_process.py"
click node_pon "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/seq_post_process.py"
click node_csv "https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/seq_post_process.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_pipeline,node_qc,node_unaligned,node_umi,node_alignment toneBlue
class node_grouping,node_consensus_calls,node_consensus_filter toneAmber
class node_metrics,node_variant_calling,node_enumeration toneMint
class node_postprocess,node_pon,node_csv toneRose
class node_researcher,node_bio_tools toneIndigo
```

## Components

### Read preparation

- [Pipeline runner](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh): `scripts/capp_seq_pipeline.sh`
- [FASTQ quality](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh): `scripts/capp_seq_pipeline.sh`
- [BAM conversion](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh): `scripts/capp_seq_pipeline.sh`
- [UMI extraction](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh): `scripts/capp_seq_pipeline.sh`
- [Read alignment](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh): `scripts/capp_seq_pipeline.sh`

### UMI consensus

- [UMI grouping](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh): `scripts/capp_seq_pipeline.sh`
- [Consensus calling](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh): `scripts/capp_seq_pipeline.sh`
- [Consensus filtering](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh): `scripts/capp_seq_pipeline.sh`

### Variant analysis

- [Capture metrics](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh): `scripts/capp_seq_pipeline.sh`
- [Variant calling](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh): `scripts/capp_seq_pipeline.sh`
- [Read enumeration](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/capp_seq_pipeline.sh): `scripts/capp_seq_pipeline.sh`

### Results

- [Variant merging](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/seq_post_process.py): `scripts/seq_post_process.py`
- [PoN filtering](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/seq_post_process.py): `scripts/seq_post_process.py`
- [CSV output](https://github.com/green-lab-mdacc/capp_seq_pipeline/blob/main/scripts/seq_post_process.py): `scripts/seq_post_process.py`

### Other components

- **Sample inputs**
- **Bioinformatics tools**

## Connections

- Sample inputs → Pipeline runner: provides reads (evidence: `README.md`)
- Pipeline runner → FASTQ quality: runs (evidence: `README.md`)
- Pipeline runner → BAM conversion: converts reads (evidence: `README.md`)
- Pipeline runner → UMI extraction: extracts UMIs (evidence: `README.md`)
- Pipeline runner → Read alignment: aligns reads (evidence: `README.md`)
- Pipeline runner → UMI grouping: groups reads (evidence: `README.md`)
- Pipeline runner → Consensus calling: calls consensus (evidence: `README.md`)
- Pipeline runner → Consensus filtering: filters reads (evidence: `README.md`)
- Pipeline runner → Capture metrics: computes metrics (evidence: `README.md`)
- Pipeline runner → Variant calling: calls variants (evidence: `README.md`)
- Pipeline runner → Read enumeration: enumerates reads (evidence: `README.md`)
- Pipeline runner → Variant merging: runs script (evidence: `README.md`)
- Bioinformatics tools → FASTQ quality: runs FastQC (evidence: `README.md`)
- Bioinformatics tools → BAM conversion: converts FASTQ (evidence: `README.md`)
- Bioinformatics tools → UMI extraction: extracts UMIs (evidence: `README.md`)
- Bioinformatics tools → Read alignment: aligns and merges (evidence: `README.md`)
- Bioinformatics tools → UMI grouping: groups families (evidence: `README.md`)
- Bioinformatics tools → Consensus calling: calls consensus (evidence: `README.md`)
- Bioinformatics tools → Consensus filtering: filters consensus (evidence: `README.md`)
- Bioinformatics tools → Capture metrics: collects metrics (evidence: `README.md`)
- Bioinformatics tools → Variant calling: calls variants (evidence: `README.md`)
- Bioinformatics tools → Read enumeration: counts reads (evidence: `README.md`)
- Variant merging → PoN filtering: optionally filters (evidence: `README.md`)
- Variant merging → CSV output: writes CSV (evidence: `scripts/seq_post_process.py`)
