# lukas-1/crispr_4sgrna architecture

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

- Interactive diagram: https://gitdiagram.com/lukas-1/crispr_4sgrna
- Repository: https://github.com/lukas-1/crispr_4sgrna

## Overview

##### Project type and purpose
- This is an R-based bioinformatics pipeline for designing and analyzing CRISPR guide RNA libraries. It comprises:
- A “library compilation” section under R scripts (functions, preparation, CRISPRa/ko/i builds, analysis)
- An “individual experiments” section that processes sequencing runs (PacBio, Nanopore, Illumina)
- An “arrayed screen” analysis section for plate-based CRISPR screens
- A Shiny app for interactive exploration of compiled libraries and results
- renv.lock for reproducible package management

##### High-level architectural components
- Reference data sources (Bioconductor org.Hs.eg.db/org.Mm.eg.db, dbSNP, Kaviar, GENCODE, GO, FANTOM5, BioMart)
- R pipeline modules
– Library functions (generic utilities)
– Prepare modules (collect annotations, divide genes into chunks, compile TSS, gene lists, essential genes, transcription factors, secretome, etc.)
– Build modules (CRISPRa, CRISPRko, CRISPRi for human and mouse; interfacing with external design tools: GuideScan, CRISPOR, GPP sgRNA designer)
- Sequencing-run processors
– PacBio pipelines
– Nanopore pipelines
– Illumina paired-end 2sg/4sg pipelines
- Arrayed screen analysis (plate QC, score calculations, visualizations)
- Interactive Shiny application (data ingestion, tidying, annotation, UI)
- Environment manager (renv)

##### Data stores and flows
- Input files: gene lists (Entrez, Ensembl, HGNC), polymorphism data, pre-existing sgRNA libraries, raw sequencing data
- Intermediate files: mapped sgRNA alignments, GuideScan/CRISPOR output, filtered and annotated guide tables, chunked data frames
- Experimental outputs: FASTA/FASTQ consensus reads, barcode counts, QC metrics, summary TSVs/XLSX
- Final outputs: compiled CRISPR library TSVs, plots (heatmaps, volcano, QC), Shiny app data objects

##### External tools/services
- GuideScan (off‐line or REST)
- CRISPOR (off‐line or REST)
- Broad GPP sgRNA designer API
- Third-party databases: org.Db packages, dbSNP flat files, Kaviar, GENCODE GTF/annotation, GO annotation files
- Sequencing instruments (PacBio, Sequel-II, Nanopore, Illumina)

##### Key architectural patterns and principles
- Modular folder structure: each major pipeline step in its own directory
- Separation of concerns: annotation vs. library build vs. sequencing analysis vs. visualization
- File-based pipeline, no centralized database
- Reproducibility via renv (isolated package versions)
- Extensibility: easily add new experiment pipelines under “Individual experiments”

## Diagram (Mermaid)

```mermaid
graph TD
    %% Pre-processing Layer
    subgraph "Pre-processing"
        direction TB
        RefData["Reference Data Sources"]:::rmod
        LibFuncs["Library Functions"]:::rmod
        PrepareHum["Prepare Modules (Human)"]:::rmod
        PrepareMus["Prepare Modules (Mouse)"]:::rmod
    end

    %% Library Construction Layer
    subgraph "Library Construction"
        direction TB
        subgraph "Build Modules - Human"
            direction TB
            BuildA["Human CRISPRa Build Module"]:::rmod
            BuildKo["Human CRISPRko Build Module"]:::rmod
            BuildI["Human CRISPRi Build Module"]:::rmod
        end
        subgraph "Build Modules - Mouse"
            direction TB
            BuildA_M["Mouse CRISPRa Build Module"]:::rmod
            BuildKo_M["Mouse CRISPRko Build Module"]:::rmod
        end
        AnalyzeLib["Analysis Modules"]:::rmod
    end

    %% Sequencing Analysis Layer
    subgraph "Sequencing Analysis"
        direction TB
        subgraph "Individual Experiments"
            direction TB
            PacBio["PacBio Processor"]:::rmod
            Nano["Nanopore Processor"]:::rmod
            Illumina["Illumina Processor"]:::rmod
        end
        ArrayScreen["Arrayed Screen Analysis"]:::rmod
    end

    %% Visualization/UI Layer
    subgraph "Visualization/UI"
        direction TB
        ShinyApp["Shiny Application"]:::ui
    end

    %% File Stores
    InputStore["Input File Store"]:::store
    StagingStore["Intermediate Staging Store"]:::store
    OutputStore["Final Output Store"]:::store

    %% External Tools
    GuideScan["GuideScan"]:::ext
    CRISPOR["CRISPOR"]:::ext
    GPP["GPP sgRNA Designer API"]:::ext

    %% Environment
    Renv["Environment Manager (renv)"]:::env

    %% Data Flows
    RefData -->|"annotations, SNPs, GTF"| PrepareHum
    RefData -->|"annotations, SNPs, GTF"| PrepareMus
    LibFuncs --> PrepareHum
    LibFuncs --> PrepareMus

    PrepareHum -->|"gene chunks TSV"| BuildA
    PrepareHum --> BuildKo
    PrepareHum --> BuildI
    PrepareMus --> BuildA_M
    PrepareMus --> BuildKo_M

    BuildA -->|".tsv"| StagingStore
    BuildKo --> StagingStore
    BuildI --> StagingStore
    BuildA_M --> StagingStore
    BuildKo_M --> StagingStore

    BuildA -->|JSON API request| GuideScan
    BuildA -->|JSON API request| CRISPOR
    BuildKo -->|JSON API request| GPP
    BuildI -->|JSON API request| GuideScan
    BuildA_M -->|JSON API request| CRISPOR
    BuildKo_M -->|JSON API request| GPP

    GuideScan -->|JSON response| BuildA
    CRISPOR -->|JSON response| BuildA_M
    GPP -->|JSON response| BuildKo

    StagingStore --> AnalyzeLib
    AnalyzeLib -->|plots, tables| OutputStore

    InputStore --> PacBio
    InputStore --> Nano
    InputStore --> Illumina

    PacBio -->|"FASTA/FASTQ"| StagingStore
    Nano -->|"FASTQ"| StagingStore
    Illumina -->|"FASTQ"| StagingStore

    StagingStore --> ArrayScreen
    ArrayScreen -->|"QC metrics, scores"| OutputStore

    OutputStore --> ShinyApp

    Renv --> RefData
    Renv --> PrepareHum
    Renv --> PrepareMus
    Renv --> BuildA
    Renv --> BuildKo
    Renv --> BuildI
    Renv --> BuildA_M
    Renv --> BuildKo_M
    Renv --> AnalyzeLib
    Renv --> PacBio
    Renv --> Nano
    Renv --> Illumina
    Renv --> ArrayScreen
    Renv --> ShinyApp

    %% Click events
    click RefData "https://github.com/lukas-1/crispr_4sgrna/blob/master/R scripts/1) R functions/01) Retrieving annotation data for a gene.R"
    click LibFuncs "https://github.com/lukas-1/crispr_4sgrna/tree/master/R scripts/1) R functions/"
    click PrepareHum "https://github.com/lukas-1/crispr_4sgrna/tree/master/R scripts/2) Prepare for compiling CRISPR libraries/"
    click PrepareMus "https://github.com/lukas-1/crispr_4sgrna/tree/master/R scripts/7) Prepare for compiling mouse CRISPR libraries/"
    click BuildA "https://github.com/lukas-1/crispr_4sgrna/tree/master/R scripts/3) Build CRISPRa library/"
    click BuildKo "https://github.com/lukas-1/crispr_4sgrna/tree/master/R scripts/4) Build CRISPRko library/"
    click BuildI "https://github.com/lukas-1/crispr_4sgrna/tree/master/R scripts/5) Build CRISPRi library/"
    click BuildA_M "https://github.com/lukas-1/crispr_4sgrna/tree/master/R scripts/8) Build mouse CRISPRa library/"
    click BuildKo_M "https://github.com/lukas-1/crispr_4sgrna/tree/master/R scripts/9) Build mouse CRISPRko library/"
    click AnalyzeLib "https://github.com/lukas-1/crispr_4sgrna/tree/master/R scripts/6) Analyze CRISPR libraries/"
    click PacBio "https://github.com/lukas-1/crispr_4sgrna/tree/master/Individual experiments/"
    click ArrayScreen "https://github.com/lukas-1/crispr_4sgrna/tree/master/Analysis_of_arrayed_screens/"
    click ShinyApp "https://github.com/lukas-1/crispr_4sgrna/tree/master/shiny/"
    click Renv "https://github.com/lukas-1/crispr_4sgrna/blob/master/renv.lock"

    %% Styles
    classDef rmod fill:#E0F3FF,stroke:#0366D6,stroke-width:2px
    classDef store fill:#E6FFEA,stroke:#22863A,stroke-width:2px
    classDef ext fill:#FFF5E5,stroke:#D15704,stroke-width:2px,stroke-dasharray: 5 5
    classDef ui fill:#F5E6FF,stroke:#6F42C1,stroke-width:2px
    classDef env fill:#F2F2F2,stroke:#6A737D,stroke-width:2px,stroke-dasharray: 2 2
```
