# bbglab/intogen-plus architecture

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

- Interactive diagram: https://gitdiagram.com/bbglab/intogen-plus
- Repository: https://github.com/bbglab/intogen-plus

## Overview

##### Main Components

a) Pipeline Orchestration Layer:
- Nextflow workflow engine as the central coordinator
- Configuration management (nextflow.config, config/*.conf files)

b) Core Processing Components:
- Core module (core/) for basic processing and parsing
- Combination module (combination/) for results integration
- Multiple analysis containers (build/containers/*)

c) Data Processing Modules (represent as separate components):
- VEP (Variant Effect Predictor)
- HotMAPS
- dNdScv
- OncodriveClustL
- OncodriveFML
- MutPanning
- CBaSE
- DeconstructSig

d) Data Management:
- Input data handling
- Background datasets (build/datasets/)
- Results processing

**[Input Layer]**

**[Orchestration Layer (Nextflow)]**

**[Core Processing Layer]**

**[Analysis Modules Layer]**

**[Data Integration Layer]**

**[Output Layer]**

##### Specific Design Elements

- Rectangles: Main processing components
- Hexagons: External tools/containers

- Blue: Core components
- Green: Data processing modules
- Yellow: Data stores
- Gray: External dependencies
- Red: Critical path components

##### Component Relationships

Following interactions:
- Dependencies between modules
- Parallel execution paths
- Data transformation steps

##### Key Aspects to Highlight

a) Containerization:
- Singularity containers for each tool
- Isolation boundaries

b) Data Flow:
- Input mutation data
- Intermediate processing steps
- Results combination
- Final driver discovery output

c) Pipeline Control:
- Error handling paths
- Resume capability
- Resource management

##### Technical Details

- Version information (e.g., hg38, vep111)
- Resource requirements
- External dependencies
- License information

##### Error handling and recovery mechanisms

Remember to indicate that this is a high-resource pipeline designed for cluster environments, and show the distributed nature of the processing where applicable.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Input
        IN[Input Data]
        CFG[Configuration Files]:::config
    end

    subgraph Orchestration
        NF[Nextflow Workflow]:::workflow
        PR[Pipeline Runner]:::runner
        CM[Container Management]:::containers
    end

    subgraph Core
        CRM[Core Module]:::core
        CMB[Combination Module]:::core
        PRS[Parsers]:::core
        PST[Post Processing]:::core
    end

    subgraph "Analysis Modules"
        VEP[VEP]:::analysis
        HOT[HotMAPS]:::analysis
        DND[dNdScv]:::analysis
        OCL[OncodriveClustL]:::analysis
        OFM[OncodriveFML]:::analysis
        MTP[MutPanning]:::analysis
        CBS[CBaSE]:::analysis
        DCS[DeconstructSig]:::analysis
    end

    subgraph "Data Management"
        BGD[(Background Datasets)]:::data
        RES[(Results Storage)]:::data
    end

    subgraph Output
        DRV[Driver Discovery Results]
    end

    %% Relationships
    IN --> NF
    CFG --> NF
    NF --> CRM
    NF --> CM
    PR --> NF
    
    CRM --> PRS
    PRS --> BGD
    
    CM --> VEP & HOT & DND & OCL & OFM & MTP & CBS & DCS
    
    VEP & HOT & DND & OCL & OFM & MTP & CBS & DCS --> PST
    PST --> CMB
    CMB --> RES
    RES --> DRV

    %% Click Events
    click NF "https://github.com/bbglab/intogen-plus/blob/master/intogen.nf"
    click CFG "https://github.com/bbglab/intogen-plus/tree/master/config/"
    click PR "https://github.com/bbglab/intogen-plus/blob/master/intogen.sh"
    click CRM "https://github.com/bbglab/intogen-plus/tree/master/core/intogen_core/"
    click CMB "https://github.com/bbglab/intogen-plus/tree/master/combination/intogen_combination/"
    click CM "https://github.com/bbglab/intogen-plus/tree/master/build/containers/"
    click VEP "https://github.com/bbglab/intogen-plus/tree/master/build/containers/vep/"
    click HOT "https://github.com/bbglab/intogen-plus/tree/master/build/containers/hotmaps/"
    click DND "https://github.com/bbglab/intogen-plus/tree/master/build/containers/dndscv/"
    click OCL "https://github.com/bbglab/intogen-plus/tree/master/build/containers/oncodriveclustl/"
    click OFM "https://github.com/bbglab/intogen-plus/tree/master/build/containers/oncodrivefml/"
    click MTP "https://github.com/bbglab/intogen-plus/tree/master/build/containers/mutpanning/"
    click CBS "https://github.com/bbglab/intogen-plus/tree/master/build/containers/cbase/"
    click DCS "https://github.com/bbglab/intogen-plus/tree/master/build/containers/deconstructsig/"
    click BGD "https://github.com/bbglab/intogen-plus/tree/master/build/datasets/"
    click PRS "https://github.com/bbglab/intogen-plus/tree/master/core/intogen_core/parsers/"
    click PST "https://github.com/bbglab/intogen-plus/tree/master/core/intogen_core/postprocess/"

    %% Styling
    classDef workflow fill:#f9f,stroke:#333
    classDef runner fill:#fcc,stroke:#333
    classDef containers fill:#cfc,stroke:#333
    classDef core fill:#ccf,stroke:#333
    classDef analysis fill:#ffc,stroke:#333
    classDef data fill:#ddd,stroke:#333
    classDef config fill:#fcf,stroke:#333

    %% Legend
    subgraph Legend
        L1[Workflow]:::workflow
        L2[Runner]:::runner
        L3[Containers]:::containers
        L4[Core Components]:::core
        L5[Analysis Modules]:::analysis
        L6[(Data Storage)]:::data
        L7[Configuration]:::config
    end
```
