# nmquijada/tormes architecture

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

- Interactive diagram: https://gitdiagram.com/nmquijada/tormes
- Repository: https://github.com/nmquijada/tormes

## Overview

TORMES is a bacterial whole-genome sequencing analysis pipeline. Users provide metadata and raw paired-end reads, assembled genomes, or both; the pipeline performs documented analysis stages and produces an interactive report. The README describes capabilities but no source excerpts were supplied, so stage implementations are represented by the existing v1.3.0 executable directory, and relationships are limited to those documented. The report renderer is represented by its executable path.

Main entry points: [`bin/version-1.3.0/tormes`](https://github.com/nmquijada/tormes/blob/master/bin/version-1.3.0/tormes) (TORMES pipeline), [`bin/version-1.3.0/tormes-report`](https://github.com/nmquijada/tormes/blob/master/bin/version-1.3.0/tormes-report) (Interactive report), [`bin/version-1.3.0`](https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0) (Quality filtering)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflow["Pipeline workflow"]
  node_pipeline["TORMES pipeline<br/>[tormes]"]
end

subgraph group_genome["Genome analysis"]
  node_quality["Quality filtering<br/>[version-1.3.0]"]
  node_assembly["Genome assembly<br/>[version-1.3.0]"]
  node_ordering["Draft ordering<br/>[version-1.3.0]"]
  node_taxonomy["Taxonomic ID<br/>[version-1.3.0]"]
  node_rrna["16S analysis<br/>[version-1.3.0]"]
  node_annotation["Genome annotation<br/>[version-1.3.0]"]
end

subgraph group_typing["Typing and screening"]
  node_mlst["MLST typing<br/>[version-1.3.0]"]
  node_resistance["Resistance screening<br/>[version-1.3.0]"]
  node_virulence["Virulence screening<br/>[version-1.3.0]"]
  node_pangenome["Pangenome comparison<br/>[version-1.3.0]"]
  node_specialized["Extended genus analyses<br/>[version-1.3.0]"]
end

subgraph group_reporting["Results and reporting"]
  node_reportgen["Report generation<br/>[tormes]"]
  node_report["Interactive report<br/>[tormes-report]"]
end

node_user(("Genome analyst"))

node_user -->|"provides genomes"| node_pipeline
node_pipeline -->|"runs filtering"| node_quality
node_pipeline -->|"runs assembly"| node_assembly
node_pipeline -->|"optionally orders"| node_ordering
node_pipeline -->|"identifies taxa"| node_taxonomy
node_pipeline -->|"analyzes 16S"| node_rrna
node_pipeline -->|"annotates genomes"| node_annotation
node_pipeline -->|"optionally types"| node_mlst
node_pipeline -->|"screens resistance"| node_resistance
node_pipeline -->|"screens virulence"| node_virulence
node_pipeline -->|"optionally compares"| node_pangenome
node_pipeline -->|"enables genus analyses"| node_specialized
node_pipeline -->|"generates report"| node_reportgen
node_reportgen -->|"renders report"| node_report
node_user -->|"views results"| node_report

click node_pipeline "https://github.com/nmquijada/tormes/blob/master/bin/version-1.3.0/tormes"
click node_quality "https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0"
click node_assembly "https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0"
click node_ordering "https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0"
click node_taxonomy "https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0"
click node_rrna "https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0"
click node_annotation "https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0"
click node_mlst "https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0"
click node_resistance "https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0"
click node_virulence "https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0"
click node_pangenome "https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0"
click node_specialized "https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0"
click node_reportgen "https://github.com/nmquijada/tormes/blob/master/bin/version-1.3.0/tormes"
click node_report "https://github.com/nmquijada/tormes/blob/master/bin/version-1.3.0/tormes-report"

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 toneBlue
class node_quality,node_assembly,node_ordering,node_taxonomy,node_rrna,node_annotation toneAmber
class node_mlst,node_resistance,node_virulence,node_pangenome,node_specialized toneMint
class node_reportgen,node_report toneRose
class node_user toneIndigo
```

## Components

### Pipeline workflow

- [TORMES pipeline](https://github.com/nmquijada/tormes/blob/master/bin/version-1.3.0/tormes): `bin/version-1.3.0/tormes`

### Genome analysis

- [Quality filtering](https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0): `bin/version-1.3.0`
- [Genome assembly](https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0): `bin/version-1.3.0`
- [Draft ordering](https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0): `bin/version-1.3.0`
- [Taxonomic ID](https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0): `bin/version-1.3.0`
- [16S analysis](https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0): `bin/version-1.3.0`
- [Genome annotation](https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0): `bin/version-1.3.0`

### Typing and screening

- [MLST typing](https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0): `bin/version-1.3.0`
- [Resistance screening](https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0): `bin/version-1.3.0`
- [Virulence screening](https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0): `bin/version-1.3.0`
- [Pangenome comparison](https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0): `bin/version-1.3.0`
- [Extended genus analyses](https://github.com/nmquijada/tormes/tree/master/bin/version-1.3.0): `bin/version-1.3.0`

### Results and reporting

- [Report generation](https://github.com/nmquijada/tormes/blob/master/bin/version-1.3.0/tormes): `bin/version-1.3.0/tormes`
- [Interactive report](https://github.com/nmquijada/tormes/blob/master/bin/version-1.3.0/tormes-report): `bin/version-1.3.0/tormes-report`

### Other components

- **Genome analyst**

## Connections

- Genome analyst → TORMES pipeline: provides genomes (evidence: `README.md`)
- TORMES pipeline → Quality filtering: runs filtering (evidence: `README.md`)
- TORMES pipeline → Genome assembly: runs assembly (evidence: `README.md`)
- TORMES pipeline → Draft ordering: optionally orders (evidence: `README.md`)
- TORMES pipeline → Taxonomic ID: identifies taxa (evidence: `README.md`)
- TORMES pipeline → 16S analysis: analyzes 16S (evidence: `README.md`)
- TORMES pipeline → Genome annotation: annotates genomes (evidence: `README.md`)
- TORMES pipeline → MLST typing: optionally types (evidence: `README.md`)
- TORMES pipeline → Resistance screening: screens resistance (evidence: `README.md`)
- TORMES pipeline → Virulence screening: screens virulence (evidence: `README.md`)
- TORMES pipeline → Pangenome comparison: optionally compares (evidence: `README.md`)
- TORMES pipeline → Extended genus analyses: enables genus analyses (evidence: `README.md`)
- TORMES pipeline → Report generation: generates report (evidence: `README.md`)
- Report generation → Interactive report: renders report (evidence: `README.md`)
- Genome analyst → Interactive report: views results (evidence: `README.md`)
