# rivm-bioinformatics/ampligone architecture

> Architecture diagram of the GitHub repository rivm-bioinformatics/ampligone, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rivm-bioinformatics/ampligone
- Repository: https://github.com/rivm-bioinformatics/ampligone

## Overview

##### Main Components

a. Input Processing Layer:
- FastQ file input handling (Illumina/Nanopore data)
- Reference sequence input
- Primer coordinates input

b. Core Processing Components:
- Mapping/Alignment Module
- Primer Detection Module
- Read Trimming Engine
- Coordinate Translation System

c. Output Processing Layer:
- Cleaned FastQ generation
- Quality control metrics

**┌─────────────────────────────────────┐**
- Input Layer              │
- FastQ Files                      │
- Reference Sequences              │
- Primer Coordinates               │
- ┘
- ↓
**┌─────────────────────────────────────┐**
- Processing Core             │
- ┌─────────────┐    ┌────────────┐ │
- Mapping   │ → │Coordinate   │ │
- Module    │    │Processing  │ │
- ┘    └────────────┘ │
- ↓              ↓          │
- ┌─────────────┐    ┌────────────┐ │
- Primer    │ → │  Read       │ │
- Detection  │    │ Trimming   │ │
- ┘    └────────────┘ │
- ┘
- ↓
**┌─────────────────────────────────────┐**
- Output Layer              │
- Cleaned FastQ Files              │
- QC Metrics                       │
- ┘

##### Key Components to Highlight

- cut_reads.py: Primary read processing
- cutlery.py: Core trimming functions
- fasta2bed.py: Reference sequence handling
- mappreset.py: Mapping configurations
- func.py: Utility functions
- io_ops.py: Input/Output operations

##### Important Relationships

- Data flow direction between components
- Feedback loops for quality control
- Error handling paths
- Parallel processing capabilities

##### Technical Details

- Supported file formats (FastQ)
- Supported sequencing platforms (Illumina, Nanopore)
- Amplicon type handling (end-to-end, end-to-mid, fragmented)
- Reference coordinate system

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Input
        FastQ[FastQ Files]
        RefSeq[Reference Sequences]
        PrimCoord[Primer Coordinates]
        IO["Input Processing"]:::io
        click IO "https://github.com/RIVM-bioinformatics/AmpliGone/blob/main/AmpliGone/io_ops.py"
        FastQ & RefSeq & PrimCoord --> IO
        RefProc["Reference Sequence Processing"]:::ref
        click RefProc "https://github.com/RIVM-bioinformatics/AmpliGone/blob/main/AmpliGone/fasta2bed.py"
        RefSeq --> RefProc
    end

    subgraph Processing
        MapMod["Mapping/Alignment Module"]:::map
        click MapMod "https://github.com/RIVM-bioinformatics/AmpliGone/blob/main/AmpliGone/mappreset.py"
        CoordProc["Coordinate Processing"]
        PrimDet["Primer Detection"]
        ReadTrim["Read Trimming Engine"]:::trim
        click ReadTrim "https://github.com/RIVM-bioinformatics/AmpliGone/blob/main/AmpliGone/cutlery.py"
        CoreProc["Core Processing"]:::core
        click CoreProc "https://github.com/RIVM-bioinformatics/AmpliGone/blob/main/AmpliGone/cut_reads.py"
        Utils["Utility Functions"]:::utils
        click Utils "https://github.com/RIVM-bioinformatics/AmpliGone/blob/main/AmpliGone/func.py"
        
        IO --> MapMod
        MapMod --> CoordProc
        CoordProc --> PrimDet
        PrimDet --> ReadTrim
        Utils --> CoreProc
        ReadTrim --> CoreProc
    end

    subgraph Output
        CleanFastQ["Cleaned FastQ Files"]
        QCMetrics["Quality Control Metrics"]
        MainApp["Main Application"]:::main
        click MainApp "https://github.com/RIVM-bioinformatics/AmpliGone/blob/main/AmpliGone/AmpliGone.py"
        
        CoreProc --> MainApp
        MainApp --> CleanFastQ
        MainApp --> QCMetrics
    end

    subgraph Documentation
        Version["Version Control"]:::version
        click Version "https://github.com/RIVM-bioinformatics/AmpliGone/blob/main/AmpliGone/version.py"
        UserGuide["User Guide"]:::docs
        click UserGuide "https://github.com/RIVM-bioinformatics/AmpliGone/blob/main/docs/user-guide.md"
        AmpliconSpec["Amplicon Specifications"]:::docs
        click AmpliconSpec "https://github.com/RIVM-bioinformatics/AmpliGone/blob/main/docs/amplicon-types.md"
    end

    classDef io fill:#3498db,stroke:#2980b9,color:white
    classDef ref fill:#2ecc71,stroke:#27ae60,color:white
    classDef map fill:#e74c3c,stroke:#c0392b,color:white
    classDef trim fill:#9b59b6,stroke:#8e44ad,color:white
    classDef core fill:#f1c40f,stroke:#f39c12,color:black
    classDef utils fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef main fill:#e67e22,stroke:#d35400,color:white
    classDef version fill:#1abc9c,stroke:#16a085,color:white
    classDef docs fill:#34495e,stroke:#2c3e50,color:white
```
