# sirselim/illumina450k_filtering architecture

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

- Interactive diagram: https://gitdiagram.com/sirselim/illumina450k_filtering
- Repository: https://github.com/sirselim/illumina450k_filtering

## Overview

##### Project type and purpose
- This is an R‐based bioinformatics QC/filter pipeline, not a full‐stack application.
- Purpose: remove ‘bad’ (cross-reactive, multimapping, variant‐containing, or detection-failed) probes from Illumina 450k/EPIC methylation array data prior to downstream analysis.

##### File structure
- Top level:
- CSV/TXT resources for known ‘bad’ probe lists
- `EPIC/` folder holding six supplementary CSVs (cross-reactive & variant lists)
- A single README with usage instructions and R code snippets
- No backend/frontend division—everything runs inside R.
- No build or deployment scripts; it’s a data resource + R pipeline.

##### README for architectural clues
- Workflow stages:
a. Probe sequences (Bowtie2) → generate multimapping list
b. Import non-specific probe list (Chen et al.)
c. Detect failed probes in samples via `detectionP()`
d. Import EPIC lists (Pidsley et al.)
e. Combine all lists → filter β‐value matrix
- Dependencies: R, Bioconductor (minfi), Bowtie2 outputs, Illumina manifest.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Inputs
    RawData["Raw Array Data (IDAT files)"]:::input
    ChenImport["Import Chen et al. probes"]:::input
    Bowtie2Bed["Bowtie2 multimap (.bed)"]:::input
    Bowtie2Txt["Bowtie2 multimap (.txt)"]:::input
    subgraph "EPIC Probe Lists"
        EP1["13059_2016_1066_MOESM1_ESM.csv"]:::input
        EP2["13059_2016_1066_MOESM2_ESM.csv"]:::input
        EP3["13059_2016_1066_MOESM3_ESM.csv"]:::input
        EP4["13059_2016_1066_MOESM4_ESM.csv"]:::input
        EP5["13059_2016_1066_MOESM5_ESM.csv"]:::input
        EP6["13059_2016_1066_MOESM6_ESM.csv"]:::input
    end
    Manifest["Illumina Manifest v1.0 B5"]:::external
    PubChen["Chen et al. Publication"]:::external
    PubPidsley["Pidsley et al. Publication"]:::external

    %% Processing Modules
    Ingestion["Data ingestion & detection (RGset, detectionP)"]:::module
    ImportLists["Probe-list import (read.csv/read.table)"]:::module
    Merge["Merge filter lists (unique &)"]:::module
    FilterEngine["Filtering Engine (apply mask to beta_norm)"]:::module

    %% Outputs
    FilteredMatrix["Filtered β-value matrix"]:::output
    QCStats["QC statistics & logs"]:::output

    %% Documentation & Metadata
    README["README.md"]:::module
    Citation["CITATION.cff"]:::external
    Gitignore[".gitignore"]:::external

    %% Flow
    RawData --> Ingestion
    Ingestion --> Merge
    ChenImport --> ImportLists
    Bowtie2Bed --> ImportLists
    Bowtie2Txt --> ImportLists
    ImportLists --> Merge
    EP1 --> ImportLists
    EP2 --> ImportLists
    EP3 --> ImportLists
    EP4 --> ImportLists
    EP5 --> ImportLists
    EP6 --> ImportLists
    Manifest -.-> ImportLists
    PubChen -.-> ChenImport
    PubPidsley -.-> EP1
    Merge --> FilterEngine
    FilterEngine --> FilteredMatrix
    FilterEngine --> QCStats

    %% Docs & metadata arrows
    README --> Ingestion
    README --> ImportLists
    Citation -.-> Manifest
    Gitignore -.-> README

    %% Click Events
    click ChenImport "https://github.com/sirselim/illumina450k_filtering/blob/master/48639-non-specific-probes-Illumina450k.csv"
    click Bowtie2Bed "https://github.com/sirselim/illumina450k_filtering/blob/master/HumanMethylation450_15017482_v.1.1_hg19_bowtie_multimap.bed"
    click Bowtie2Txt "https://github.com/sirselim/illumina450k_filtering/blob/master/HumanMethylation450_15017482_v.1.1_hg19_bowtie_multimap.txt"
    click EP1 "https://github.com/sirselim/illumina450k_filtering/blob/master/EPIC/13059_2016_1066_MOESM1_ESM.csv"
    click EP2 "https://github.com/sirselim/illumina450k_filtering/blob/master/EPIC/13059_2016_1066_MOESM2_ESM.csv"
    click EP3 "https://github.com/sirselim/illumina450k_filtering/blob/master/EPIC/13059_2016_1066_MOESM3_ESM.csv"
    click EP4 "https://github.com/sirselim/illumina450k_filtering/blob/master/EPIC/13059_2016_1066_MOESM4_ESM.csv"
    click EP5 "https://github.com/sirselim/illumina450k_filtering/blob/master/EPIC/13059_2016_1066_MOESM5_ESM.csv"
    click EP6 "https://github.com/sirselim/illumina450k_filtering/blob/master/EPIC/13059_2016_1066_MOESM6_ESM.csv"
    click README "https://github.com/sirselim/illumina450k_filtering/blob/master/README.md"
    click Citation "https://github.com/sirselim/illumina450k_filtering/blob/master/CITATION.cff"
    click Gitignore "https://github.com/sirselim/illumina450k_filtering/blob/master/.gitignore"

    %% Styles
    classDef input fill:#9f6,stroke:#333,stroke-width:1px
    classDef module fill:#6cf,stroke:#333,stroke-width:1px
    classDef output fill:#f96,stroke:#333,stroke-width:1px
    classDef external fill:#eee,stroke:#999,stroke-dasharray: 5 5,stroke-width:1px
```
