# sudlab/isoslam architecture

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

- Interactive diagram: https://gitdiagram.com/sudlab/isoslam
- Repository: https://github.com/sudlab/isoslam

## Overview

##### Main Components Identification

a) Core Processing Pipeline:
- Input/Output Handler (io.py)
- Main Processing Engine (processing.py)
- SLAM Pipeline Component (pipeline_slam_3UIs)
- Summary Generation (summary.py)

b) Supporting Components:
- Logging System (logging.py)
- Utility Functions (utils.py)
- Configuration Management (default_config.yaml)

##### Data Flow Architecture

a) Primary Data Flow:
**Input Data (BAM/VCF/GTF) → IO Module → Processing Module → Pipeline_SLAM_3UIs → Summary Module → Output Results**

b) Supporting Flows:
- Configuration flow from default_config.yaml to all components
- Logging information flow across all components

##### Technical Details to Highlight

- Python package architecture
- Integration with external tools (R scripts)
- File format handling capabilities (BAM, VCF, GTF)
- Configuration management system

Remember to include version control and CI/CD components in a separate section, as indicated by the presence of GitHub workflows and pre-commit hooks in the project structure.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Input
        BAM[(BAM Files)]
        VCF[("VCF Files")]
        GTF[("GTF Files")]
        Config[("Config Files")]
    end

    subgraph Core["Core Processing"]
        IO["Input/Output Handler"]:::core
        Process["Processing Engine"]:::core
        Pipeline["SLAM Pipeline"]:::core
        Summary["Summary Generator"]:::core
    end

    subgraph Support["Support Components"]
        Logger["Logging System"]:::support
        Utils["Utility Functions"]:::support
        DefaultConfig["Configuration Manager"]:::support
    end

    subgraph Testing["Testing & Documentation"]
        TestInfra["Testing Infrastructure"]:::test
        TestRes["Test Resources"]:::test
        APIDoc["API Documentation"]:::doc
    end

    subgraph Integration["External Integration"]
        RScript["R Script Integration"]:::integration
        CICD["CI/CD Pipeline"]:::integration
        PipeConfig["Pipeline Configuration"]:::integration
    end

    %% Main Data Flow
    BAM --> IO
    VCF --> IO
    GTF --> IO
    Config --> DefaultConfig
    
    IO --> Process
    Process --> Pipeline
    Pipeline --> Summary
    
    %% Support Flow
    DefaultConfig -.-> IO
    DefaultConfig -.-> Process
    DefaultConfig -.-> Pipeline
    
    Logger -.-> IO
    Logger -.-> Process
    Logger -.-> Pipeline
    Logger -.-> Summary
    
    Utils --> IO
    Utils --> Process
    Utils --> Pipeline
    
    %% Integration Flow
    Pipeline --> RScript
    PipeConfig -.-> Pipeline
    CICD -.-> TestInfra
    
    %% Testing Flow
    TestRes --> TestInfra
    TestInfra -.-> Core

    %% Click Events
    click IO "https://github.com/sudlab/IsoSLAM/blob/main/isoslam/io.py"
    click Process "https://github.com/sudlab/IsoSLAM/blob/main/isoslam/processing.py"
    click Pipeline "https://github.com/sudlab/IsoSLAM/tree/main/isoslam/pipeline_slam_3UIs/"
    click Summary "https://github.com/sudlab/IsoSLAM/blob/main/isoslam/summary.py"
    click Logger "https://github.com/sudlab/IsoSLAM/blob/main/isoslam/logging.py"
    click Utils "https://github.com/sudlab/IsoSLAM/blob/main/isoslam/utils.py"
    click DefaultConfig "https://github.com/sudlab/IsoSLAM/blob/main/isoslam/default_config.yaml"
    click TestInfra "https://github.com/sudlab/IsoSLAM/tree/main/tests/"
    click APIDoc "https://github.com/sudlab/IsoSLAM/tree/main/docs/api/"
    click CICD "https://github.com/sudlab/IsoSLAM/tree/main/.github/workflows/"
    click PipeConfig "https://github.com/sudlab/IsoSLAM/blob/main/isoslam/pipeline_slam_3UIs/pipeline.yml"
    click RScript "https://github.com/sudlab/IsoSLAM/blob/main/isoslam/pipeline_slam_3UIs/summarize_counts.R"
    click TestRes "https://github.com/sudlab/IsoSLAM/tree/main/tests/resources/"

    %% Styling
    classDef core fill:#90EE90,stroke:#333,stroke-width:2px
    classDef support fill:#FFE4B5,stroke:#333,stroke-width:2px
    classDef test fill:#DDA0DD,stroke:#333,stroke-width:2px
    classDef doc fill:#87CEEB,stroke:#333,stroke-width:2px
    classDef integration fill:#F08080,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["Support Components"]:::support
        L3["Testing Components"]:::test
        L4["Documentation"]:::doc
        L5["Integration"]:::integration
    end
```
