# jellyellie/parkinson-annotator architecture

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

- Interactive diagram: https://gitdiagram.com/jellyellie/parkinson-annotator
- Repository: https://github.com/jellyellie/parkinson-annotator

## Overview

##### Project type and purpose
- It is neither a typical full-stack web app nor a compiler, but a data-integration and annotation tool that likely runs as a batch or on-demand pipeline with a small user-facing search component.

##### File structure
- At present the project only contains README.md, implying the full directory layout is not yet committed.
- Expect future top-level directories such as:
· src/ (pipeline code)
· data/ (raw and processed files)
· config/ (database and API credentials)
· scripts/ (build or deployment scripts)
· tests/ (unit/integration tests)

##### README for additional insights
- Key milestones:
1. Extract data from various input files
2. Load data into SQL
3. Incorporate ClinVar API enrichment
4. Create a search function

- Use clear labels such as “Ingestion”, “Transformation”, “DB Storage”, “ClinVar API”, “Search Service”, “UI/CLI.”

##### Detail
- Pipeline stage as its own block.
- Config/orchestration layer to show how the pipeline is deployed or scheduled.
- Retry, logging, or monitoring components if present.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Pipeline Stages
    subgraph "Data Pipeline" 
        direction TB
        Ingest["Data Ingestion<br/>(CSV, JSON, XML Parsers)"]:::service
        Transform["Transformation Engine<br/>(Cleaning, Normalization)"]:::service
        ClinVar["ClinVar Enrichment Service"]:::external
        LoadDB["SQL Storage<br/>(PostgreSQL/MySQL)"]:::database
    end

    %% Search and UI
    subgraph "Access Layer"
        direction TB
        Search["Search API / Query Service<br/>(REST/GraphQL)"]:::service
        UI["User Interface / CLI"]:::ui
    end

    %% Orchestration
    Config["Config & Orchestration<br/>(Docker, Airflow, CI/CD)"]:::orchestration

    %% Data Flow
    Ingest -->|“raw data”| Transform
    Transform -->|“normalized data”| LoadDB
    Transform -->|“variant IDs”| ClinVar
    ClinVar -->|“annotations”| Transform
    LoadDB -->|“query results”| Search
    Search -->|“API response”| UI

    %% Orchestration relationships
    Config --> Ingest
    Config --> Transform
    Config --> LoadDB
    Config --> Search

    %% Styles
    classDef service fill:#D0E8FF,stroke:#007BFF,stroke-width:2px
    classDef database fill:#DFFFD0,stroke:#28A745,stroke-width:2px,shape:cylinder
    classDef external fill:#FFE8D0,stroke:#FF8C00,stroke-width:2px
    classDef ui fill:#E8D0FF,stroke:#6F42C1,stroke-width:2px
    classDef orchestration fill:#F0F0F0,stroke:#6C757D,stroke-width:2px,stroke-dasharray: 5 5
```
