# genome/bam-readcount architecture

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

- Interactive diagram: https://gitdiagram.com/genome/bam-readcount
- Repository: https://github.com/genome/bam-readcount

## Overview

##### Main Components

a. Input Processing Layer:
- BAM/CRAM file input handler
- Reference FASTA file handler
- Site list processor (for targeted analysis)

b. Core Processing Components:
- Read filtering system (mapping quality, base quality filters)
- Base counting engine
- Library-specific processing unit
- Indel processing system
- Quality metrics calculator

c. Output Generation Layer:
- Formatting engine
- Stream handler

##### Component Relationships

**Input Files → Preprocessing → Core Processing → Output Generation**

##### Specific Implementation Details

- BasicStat: Statistics calculation module
- IndelQueue: Specialized indel processing
- ReadWarnings: Warning management system
- AuxFields: Auxiliary field handling

##### Technical Details

Integration with:
- HTSlib/Samtools (for BAM/CRAM processing)
- Cairo/Cairomm (for any visualization)
- Boost libraries
- Testing framework

##### Input Layer
- BAM/CRAM Files → Reference FASTA → Site List

##### Processing Layer
- Read Filter → Base Counter → Quality Calculator

##### Output Layer
- Formatter → Tab-separated Output

##### Implementation Notes

- Core library code (src/lib/bamrc)
- Executable interface (src/exe/bam-readcount)
- Test infrastructure (test/lib/bamrc)

##### Special Features to Highlight

- CRAM support system
- Per-library processing capability
- Insertion-centric counting mode
- Warning management system

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Input
        BAM[("BAM/CRAM Files")]:::input
        REF[("Reference FASTA")]:::input
        SITE["Site List"]:::input
    end

    subgraph Processing
        MAIN["Main Application"]:::core
        click MAIN "https://github.com/genome/bam-readcount/blob/master/src/exe/bam-readcount/bamreadcount.cpp"
        
        subgraph CoreProcessing["Core Processing Components"]
            STAT["Statistics Calculator"]:::core
            click STAT "https://github.com/genome/bam-readcount/blob/master/src/lib/bamrc/BasicStat.hpp"
            INDQ["Indel Queue"]:::core
            click INDQ "https://github.com/genome/bam-readcount/blob/master/src/lib/bamrc/IndelQueue.hpp"
            INDE["Indel Entry Handler"]:::core
            click INDE "https://github.com/genome/bam-readcount/blob/master/src/lib/bamrc/IndelQueueEntry.hpp"
            WARN["Warning Management"]:::core
            click WARN "https://github.com/genome/bam-readcount/blob/master/src/lib/bamrc/ReadWarnings.hpp"
            AUX["Auxiliary Field Handler"]:::core
            click AUX "https://github.com/genome/bam-readcount/blob/master/src/lib/bamrc/auxfields.hpp"
        end

        subgraph QualityControl["Quality Control"]
            FILTER{"Read Filter"}:::filter
            QUAL{"Quality Calculator"}:::filter
        end
    end

    subgraph Testing
        ITEST["Integration Tests"]:::test
        click ITEST "https://github.com/genome/bam-readcount/blob/master/integration-test/bam-readcount_test.py"
        UTEST["Unit Tests"]:::test
        click UTEST "https://github.com/genome/bam-readcount/tree/master/test/lib/bamrc"
        TDATA["Test Data"]:::test
        click TDATA "https://github.com/genome/bam-readcount/tree/master/test-data"
    end

    subgraph Dependencies
        HTS["HTSlib"]:::dep
        click HTS "https://github.com/genome/bam-readcount/blob/master/build-common/cmake/FindHTSlib.cmake"
        SAM["Samtools"]:::dep
        click SAM "https://github.com/genome/bam-readcount/blob/master/build-common/cmake/FindSamtools.cmake"
    end

    subgraph Output
        FORMAT["Formatter"]:::output
        TSV[("Tab-separated Output")]:::output
    end

    %% Connections
    BAM --> MAIN
    REF --> MAIN
    SITE --> MAIN
    
    MAIN --> FILTER
    FILTER --> STAT
    STAT --> QUAL
    
    INDQ --> INDE
    INDE --> WARN
    WARN --> AUX
    
    QUAL --> FORMAT
    FORMAT --> TSV
    
    HTS --> MAIN
    SAM --> MAIN
    
    MAIN --> ITEST
    MAIN --> UTEST
    TDATA --> ITEST
    TDATA --> UTEST

    %% Styles
    classDef input fill:#3498db,stroke:#2980b9,color:white
    classDef core fill:#2ecc71,stroke:#27ae60,color:white
    classDef filter fill:#f1c40f,stroke:#f39c12,color:black
    classDef output fill:#e67e22,stroke:#d35400,color:white
    classDef test fill:#9b59b6,stroke:#8e44ad,color:white
    classDef dep fill:#95a5a6,stroke:#7f8c8d,color:white

    %% Legend
    subgraph Legend
        L1["Input Components"]:::input
        L2["Core Processing"]:::core
        L3["Quality Control"]:::filter
        L4["Output Components"]:::output
        L5["Testing"]:::test
        L6["Dependencies"]:::dep
    end
```
