# mattjones315/kptracer-release architecture

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

- Interactive diagram: https://gitdiagram.com/mattjones315/kptracer-release
- Repository: https://github.com/mattjones315/kptracer-release

## Overview

##### Main System Components
The system should be represented with these key components:

a. Core Processing Pipeline:
- Cassiopeia Tree Solver
- Processing Pipeline
- Analysis Module

b. Supporting Components:
- Data Processing Tools
- Visualization Interfaces
- Reproducibility Framework

**┌─ Processing Pipeline ─┐    ┌─── Tree Solver ───┐    ┌──── Analysis ────┐**
- Sequence Processing│ -> │ - Lineage Solving  │ -> │ - State Analysis │
- Data Collapsing    │    │ - Tree Generation  │    │ - Parsimony      │
- ┬─┘    └─────────┬──────────┘    └────────────────┬─┘

- ┴─────────────────────────────┬──┘

- ▼
- Results & Visualization

##### Component Details

For each major component, include:

a. Processing Pipeline:
- Input: FastQ files
- Processing scripts (*.pl, *.py)
- Data transformation utilities

b. Tree Solver:
- Lineage solving algorithms
- Simulation tools
- Utility functions

c. Analysis Module:
- State reconstruction
- Small parsimony analysis
- Statistical evaluation

##### Data Flow Indicators

- Raw data input → Processing Pipeline
- Processed data → Tree Solver
- Tree data → Analysis
- Analysis results → Visualization

##### Integration Points

Integration with external tools:
- VISION visualization platform
- PhyloVision
- R-based analysis tools

##### Integration points with visualization tools

Keep the abstraction level focused on the major components while showing the key relationships between processing stages, analysis tools, and visualization capabilities.

This system design should reflect both the computational biology nature of the project and its focus on lineage tracing and tumor evolution analysis, while maintaining clarity about how different components interact to produce the final analysis results.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Core["Core Processing Components"]
        direction TB
        PP["Processing Pipeline"]
        TS["Tree Solver"]
        AM["Analysis Module"]
        
        PP --> TS
        TS --> AM
    end

    subgraph DataProcessing["Data Processing Tools"]
        direction TB
        FP["FastQ Processing"]
        DC["Data Collapsing"]
        LP["Lineage Processing"]
        PU["Pipeline Utils"]
        
        FP --> DC
        DC --> LP
        LP --> PU
    end

    subgraph Visualization["Visualization Interfaces"]
        direction TB
        PV["PhyloVision"]
        TV["Tree Visualization"]
    end

    subgraph Reproducibility["Reproducibility Framework"]
        direction TB
        F1["Figure1_S1"]
        F2["Figure2_S2"]
        F3["Figure3_S3"]
    end

    subgraph Analysis["Analysis Components"]
        direction TB
        SA["State Analysis"]
        PA["Parsimony Analysis"]
    end

    DataProcessing --> PP
    PP --> TS
    TS --> AM
    AM --> Analysis
    Analysis --> Visualization
    Analysis --> Reproducibility

    %% Click events for component mapping
    click PP "https://github.com/mattjones315/KPTracer-release/tree/main/cassiopeia-kp/cassiopeia/ProcessingPipeline/"
    click DC "https://github.com/mattjones315/KPTracer-release/blob/main/cassiopeia-kp/cassiopeia/ProcessingPipeline/process/collapse.py"
    click PU "https://github.com/mattjones315/KPTracer-release/blob/main/cassiopeia-kp/cassiopeia/ProcessingPipeline/process/pipeline_utils.py"
    click TS "https://github.com/mattjones315/KPTracer-release/tree/main/cassiopeia-kp/cassiopeia/TreeSolver/"
    click AM "https://github.com/mattjones315/KPTracer-release/tree/main/cassiopeia-kp/cassiopeia/Analysis/"
    click SA "https://github.com/mattjones315/KPTracer-release/blob/main/cassiopeia-kp/cassiopeia/Analysis/reconstruct_states.py"
    click PA "https://github.com/mattjones315/KPTracer-release/blob/main/cassiopeia-kp/cassiopeia/Analysis/small_parsimony.py"
    click PV "https://github.com/mattjones315/KPTracer-release/blob/main/scripts/run_phylovision.R"
    click TV "https://github.com/mattjones315/KPTracer-release/blob/main/cassiopeia-kp/scripts/visualize_treeheatmap_general.R"
    click FP "https://github.com/mattjones315/KPTracer-release/blob/main/cassiopeia-kp/cassiopeia/ProcessingPipeline/process/bam10X2fastq.pl"
    click LP "https://github.com/mattjones315/KPTracer-release/blob/main/cassiopeia-kp/cassiopeia/ProcessingPipeline/process/lineageGroup.py"

    %% Styling
    classDef core fill:#2374ab
    classDef processing fill:#48a9a6
    classDef analysis fill:#e4572e
    classDef viz fill:#9b287b
    classDef repro fill:#666666

    class PP,TS,AM core
    class FP,DC,LP,PU processing
    class SA,PA analysis
    class PV,TV viz
    class F1,F2,F3 repro
```
