# omararias-gaguancela/quickprot architecture

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

- Interactive diagram: https://gitdiagram.com/omararias-gaguancela/quickprot
- Repository: https://github.com/omararias-gaguancela/quickprot

## Overview

##### Project type and purpose
- Project Type: A collection of cloud-notebook (Google Colab) data-processing pipelines.
- Purpose: Automate DIA/PRM proteomics data mining and visualization, plus peptide mapping and UniProt ID lookup, all using spreadsheet inputs and Google Drive storage.

##### File structure
- Top-level:
– LICENSE, README.md (project metadata)
– NOTEBOOKS/ (all pipeline scripts)
- In NOTEBOOKS: Six main pipeline scripts:
– QuickProt-DIA (DIA-NN + Skyline variations)
– QuickProt-PRM (heavy-label + label-free)
– QuickProt-PepSeq (DIA-NN + Skyline)
– QuickProt-ID-Search
- No separate “src” or “backend”—each pipeline is self-contained in a notebook/script.

##### Extract architecture hints from the README
- Input: User-created Google Drive folder containing raw TSV/CSV outputs from DIA-NN or Skyline.
- Compute: Executed in Google Colab environment (Jupyter) using common Python libraries (e.g., pandas, seaborn/matplotlib).
- Storage: Two output subfolders under the same Drive folder—“TABLES” (processed data tables) and “PLOTS” (TIFF figures).
- External service: QuickProt-ID-Search calls UniProt REST API to map gene names to protein IDs.

##### Main components and their interactions
a. User
b. Google Drive Storage
– Input folder (raw spreadsheets)
– Output folders (“TABLES”, “PLOTS”)
c. Google Colab Environment
– Notebook runtime (compute)
– Python libraries (pandas, numpy, matplotlib/seaborn, google-drive API)
d. Pipeline Notebooks/Scripts (six logical modules)
1. DIA-NN processing
2. Skyline-DIA processing
3. PRM heavy label
4. PRM label-free
5. PepSeq mapping (DIA-NN + Skyline)
6. UniProt ID Search
e. External Service
– UniProt REST API (for the ID-search pipeline)

- Layered view:
1. User layer (left)
2. Storage layer (Google Drive)
3. Compute layer (Google Colab notebooks)
4. External API (UniProt)
– From User to Drive (upload raw reports)
– From Drive to Colab (data ingestion)
– Between Colab modules and Drive (reading inputs, writing “TABLES”/“PLOTS”)
– From ID-Search module to UniProt API (query & response)

##### Architectural patterns
- Serverless/Notebook-as-Service: All compute is ephemeral in Colab.
- Data-centric: Storage-in-Drive acts as both input and persistent output.
- Modular pipelines: Six independent notebooks with consistent I/O patterns.

##### Technology call-outs
- Google Colab (Jupyter runtime)
- Google Drive API / mounting
- Python libraries: pandas, numpy, matplotlib/seaborn, requests (for UniProt)
- Input formats: TSV, CSV
- Output formats: TSV/CSV tables + TIFF plots

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Project Metadata
    subgraph "Project Metadata"
        README["README.md"]:::metadata
        LICENSE["LICENSE"]:::metadata
    end

    %% User Layer
    User["User"]:::user

    %% Storage Layer
    subgraph "Google Drive Storage"
        DriveInput["Raw Input Folder"]:::storage
        DriveTables["/TABLES"]:::storage
        DrivePlots["/PLOTS"]:::storage
    end

    %% Compute Layer
    subgraph "Google Colab Environment"
        direction TB
        Libs["Python Libraries\n(pandas, numpy,\nmatplotlib/seaborn,\ngoogle-drive API)"]:::compute
        subgraph "Pipeline Notebooks"
            direction TB
            DIA_DIANN["DIA-NN Processing"]:::compute
            DIA_SKYLINE["Skyline-DIA Processing"]:::compute
            PRM_HEAVY["PRM Heavy-Label"]:::compute
            PRM_FREE["PRM Label-Free"]:::compute
            PEPSEQ_DIANN["PepSeq (DIA-NN)"]:::compute
            PEPSEQ_SKYLINE["PepSeq (Skyline)"]:::compute
            ID_SEARCH["UniProt ID-Search"]:::compute
        end
    end

    %% External API
    UniProtAPI["UniProt REST API"]:::api

    %% Connections
    README --> User
    LICENSE --> User
    User -->|"upload TSV/CSV"| DriveInput
    DriveInput -->|"mount & read"| Libs
    Libs -->|"invoke"| DIA_DIANN
    Libs -->|"invoke"| DIA_SKYLINE
    Libs -->|"invoke"| PRM_HEAVY
    Libs -->|"invoke"| PRM_FREE
    Libs -->|"invoke"| PEPSEQ_DIANN
    Libs -->|"invoke"| PEPSEQ_SKYLINE
    Libs -->|"invoke"| ID_SEARCH

    DIA_DIANN -->|"writes tables"| DriveTables
    DIA_DIANN -->|"writes plots"| DrivePlots
    DIA_SKYLINE -->|"writes tables"| DriveTables
    DIA_SKYLINE -->|"writes plots"| DrivePlots
    PRM_HEAVY -->|"writes tables"| DriveTables
    PRM_HEAVY -->|"writes plots"| DrivePlots
    PRM_FREE -->|"writes tables"| DriveTables
    PRM_FREE -->|"writes plots"| DrivePlots
    PEPSEQ_DIANN -->|"writes tables"| DriveTables
    PEPSEQ_DIANN -->|"writes plots"| DrivePlots
    PEPSEQ_SKYLINE -->|"writes tables"| DriveTables
    PEPSEQ_SKYLINE -->|"writes plots"| DrivePlots

    ID_SEARCH -->|"queries"| UniProtAPI
    UniProtAPI -->|"response"| ID_SEARCH

    %% Click Events
    click README "https://github.com/omararias-gaguancela/quickprot/blob/main/README.md"
    click LICENSE "https://github.com/omararias-gaguancela/quickprot/tree/main/LICENSE"
    click DIA_DIANN "https://github.com/omararias-gaguancela/quickprot/blob/main/NOTEBOOKS/quickprot_dia_diann.py"
    click DIA_SKYLINE "https://github.com/omararias-gaguancela/quickprot/blob/main/NOTEBOOKS/quickprot_dia_skyline.py"
    click PRM_HEAVY "https://github.com/omararias-gaguancela/quickprot/blob/main/NOTEBOOKS/quickprot_prm_heavy_label.py"
    click PRM_FREE "https://github.com/omararias-gaguancela/quickprot/blob/main/NOTEBOOKS/quickprot_prm_free_label.py"
    click PEPSEQ_DIANN "https://github.com/omararias-gaguancela/quickprot/blob/main/NOTEBOOKS/quickprot_pepseq_dia_nn.py"
    click PEPSEQ_SKYLINE "https://github.com/omararias-gaguancela/quickprot/blob/main/NOTEBOOKS/quickprot_pepseq_skyline.py"
    click ID_SEARCH "https://github.com/omararias-gaguancela/quickprot/blob/main/NOTEBOOKS/quickprot_id_search.py"

    %% Styles
    classDef metadata fill:#f9f,stroke:#333,stroke-width:1px
    classDef user fill:#ddd,stroke:#888,stroke-width:1px
    classDef storage fill:#bbdefb,stroke:#0d47a1,stroke-width:1px
    classDef compute fill:#c8e6c9,stroke:#1b5e20,stroke-width:1px
    classDef api fill:#ffe0b2,stroke:#e65100,stroke-width:1px
```
