# nouscom/nous209ls-crc-uc architecture

> Architecture diagram of the GitHub repository nouscom/nous209ls-crc-uc, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nouscom/nous209ls-crc-uc
- Repository: https://github.com/nouscom/nous209ls-crc-uc

## Overview

##### Project type and purpose
- This repository is a research‐data analysis pipeline in R whose sole purpose is to generate the base plots for the figures in a publication. There is no “frontend/backend” or service layer—rather it’s a batch “figure‐generation” pipeline driven by R scripts.

##### File structure
- Top level:
- README.md – describes the study and scripts
- Scripts/ – all R scripts, organized by figure (e.g., Figure_1A-E.R, Figure_2A-F.R, etc.)
- No data files included; inputs are external and provided on request
- Each script begins with its own list of R package dependencies

##### README for additional insights
- Confirms:
- R version ≥4.3
- Scripts generate “base plots” that are then refined in graphic‐design software
- Data inputs are external

##### Main components and their interactions
a. External Data Inputs
- Clinical/tumor/genomic data files (CSV/TSV/RDS), hosted externally
b. R Environment & Packages
- R 4.3+ and packages (e.g., tidyverse, ComplexHeatmap, maftools, ggplot2)
c. R Scripts (Scripts/ directory)
- One script per figure, executing data loading → analysis → plot generation
d. Raw Plot Outputs
- PNG/PDF/EPS files emitted to an “outputs/” folder (implied)
e. Graphic Design Software
- Adobe Illustrator/InkScape or similar for final aesthetic refinements
f. Final Figures in Manuscript

Data Inputs → R Environment & Packages → R Scripts → Raw Plot Outputs → Graphic Design Tool → Final Figures

##### Architectural patterns & design principles
- This is a linear, reproducible data‐analysis pipeline.
- Separation of concerns: data ingestion, analysis logic, visualization, and post‐processing.
- Each script is an independent job (batch component) invoked manually or via a master shell/R script.

## Diagram (Mermaid)

```mermaid
flowchart TB
    PD["Project Description & Dependencies"]:::code
    Data["External Data Inputs\n(Data inputs available on request)"]:::data
    Env["R Environment (R ≥4.3)\nPackages: tidyverse, ggplot2,\nComplexHeatmap, maftools"]:::env
    subgraph "Figure Generation Scripts"
        Dir["Scripts/"]:::code
        F1["Figure_1A-E.R"]:::code
        F2["Figure_2A-F.R"]:::code
        F3["Figure_3A-E.R"]:::code
        F4["Figure_4A-G.R"]:::code
        F5A["Figure_5A.R"]:::code
        F5B["Figure_5B-E.R"]:::code
        F5F["Figure_5F.R"]:::code
        F5G["Figure_5G-J.R"]:::code
        FS1["Fig_Supplementary_1.R"]:::code
        FS2["Fig_Supplementary_2_Oncoplot.R"]:::code
    end
    Output["Raw Plot Outputs\n(PNG/PDF/EPS)"]:::output
    GD["Graphic Design Software\n(Illustrator/Inkscape)"]:::env
    Manuscript["Final Figures in Manuscript"]:::output

    PD --> Env
    PD --> Dir
    Data --> Env
    Env --> Dir
    Dir --> Output
    Output --> GD
    GD --> Manuscript

    click PD "https://github.com/nouscom/nous209ls-crc-uc/blob/main/README.md"
    click Dir "https://github.com/nouscom/nous209ls-crc-uc/tree/main/Scripts/"
    click F1 "https://github.com/nouscom/nous209ls-crc-uc/blob/main/Scripts/Figure_1A-E.R"
    click F2 "https://github.com/nouscom/nous209ls-crc-uc/blob/main/Scripts/Figure_2A-F.R"
    click F3 "https://github.com/nouscom/nous209ls-crc-uc/blob/main/Scripts/Figure_3A-E.R"
    click F4 "https://github.com/nouscom/nous209ls-crc-uc/blob/main/Scripts/Figure_4A-G.R"
    click F5A "https://github.com/nouscom/nous209ls-crc-uc/blob/main/Scripts/Figure_5A.R"
    click F5B "https://github.com/nouscom/nous209ls-crc-uc/blob/main/Scripts/Figure_5B-E.R"
    click F5F "https://github.com/nouscom/nous209ls-crc-uc/blob/main/Scripts/Figure_5F.R"
    click F5G "https://github.com/nouscom/nous209ls-crc-uc/blob/main/Scripts/Figure_5G-J.R"
    click FS1 "https://github.com/nouscom/nous209ls-crc-uc/blob/main/Scripts/Fig_Supplementary_1.R"
    click FS2 "https://github.com/nouscom/nous209ls-crc-uc/blob/main/Scripts/Fig_Supplementary_2_Oncoplot.R"

    classDef data fill:#ADD8E6,stroke:#0000FF,color:#000000
    classDef code fill:#90EE90,stroke:#008000,color:#000000
    classDef env fill:#FFFFE0,stroke:#FFD700,color:#000000
    classDef output fill:#FFA500,stroke:#FF4500,color:#000000
```
