# nordlinglab/covid19-vaccinephase3metaanalysis architecture

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

- Interactive diagram: https://gitdiagram.com/nordlinglab/covid19-vaccinephase3metaanalysis
- Repository: https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis

## Overview

##### Project type and purpose
- This is a data-analysis pipeline (not a web app) for a meta-analysis of Phase III COVID-19 vaccine trials.
- Purpose: ingest raw efficacy data, recalculate metrics, and produce standardized plots and an updated Excel dataset.

##### File structure
- Top level:
- Data files (.xlsx): vaccine_details.xlsx, rw_vaccine_details.xlsx, data_table.xlsx, rw_vaccine_details.xlsx
- Notebooks (.ipynb): meta_analysis.ipynb, vaccine_details_plot.ipynb, ve_recalculate.ipynb
- Script: rw_ve_plot.py
- Configuration: requirements.txt, .gitignore, LICENSE, README.md
- Pattern: a linear data-processing pipeline—raw data → recalculation → visualization.

##### README for additional insights
- Environment: conda + Python 3.10
- Workflow:
a. ve_recalculate.ipynb reads vaccine_details.xlsx → outputs rw_vaccine_details.xlsx
b. rw_ve_plot.py contains plotting functions
c. vaccine_details_plot.ipynb and meta_analysis.ipynb generate figures using rw_vaccine_details.xlsx

##### Elements
- Blue for data sources/outputs
- Green for processing modules
- Orange for visualization modules
- Gray for environment/infrastructure

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Data Sources"
        direction TB
        vaccine_details[(vaccine_details.xlsx)]:::data
        data_table[(data_table.xlsx)]:::data
    end

    vaccine_details -->|"reads vaccine_details.xlsx"| ve_recalculate["ve_recalculate.ipynb"]:::process
    data_table -->|"reads data_table.xlsx"| ve_recalculate

    subgraph "Conda Environment"
        direction TB
        ve_recalculate
        rw_ve_plot["rw_ve_plot.py"]:::library
        vaccine_details_plot["vaccine_details_plot.ipynb"]:::viz
        meta_analysis["meta_analysis.ipynb"]:::viz
        requirements["requirements.txt"]:::env
    end

    ve_recalculate -->|"writes rw_vaccine_details.xlsx"| rw_data[(rw_vaccine_details.xlsx)]:::data
    rw_data -->|"provides data"| vaccine_details_plot
    rw_data -->|"provides data"| meta_analysis

    rw_ve_plot -.->|"imports rw_ve_plot.py"| vaccine_details_plot
    rw_ve_plot -.->|"imports rw_ve_plot.py"| meta_analysis

    subgraph "Outputs"
        direction TB
        rw_data
        style_output["RW_visualization.mplstyle"]:::data
    end

    subgraph "Documentation"
        direction TB
        readme["README.md"]:::docs
        gitignore[".gitignore"]:::docs
        license["LICENSE"]:::docs
    end

    classDef data fill:#cce5ff,stroke:#004085;
    classDef process fill:#d4edda,stroke:#155724;
    classDef library fill:#fff3cd,stroke:#856404;
    classDef viz fill:#ffe5b4,stroke:#c69500;
    classDef env fill:#e2e3e5,stroke:#6c757d,stroke-dasharray: 5 5;
    classDef docs fill:#f8d7da,stroke:#721c24;

    click vaccine_details "https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis/blob/main/vaccine_details.xlsx"
    click data_table "https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis/blob/main/data_table.xlsx"
    click ve_recalculate "https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis/blob/main/ve_recalculate.ipynb"
    click rw_ve_plot "https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis/blob/main/rw_ve_plot.py"
    click vaccine_details_plot "https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis/blob/main/vaccine_details_plot.ipynb"
    click meta_analysis "https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis/blob/main/meta_analysis.ipynb"
    click rw_data "https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis/blob/main/rw_vaccine_details.xlsx"
    click style_output "https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis/blob/main/RW_visualization.mplstyle"
    click requirements "https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis/blob/main/requirements.txt"
    click readme "https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis/blob/main/README.md"
    click gitignore "https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis/blob/main/.gitignore"
    click license "https://github.com/nordlinglab/covid19-vaccinephase3metaanalysis/tree/main/LICENSE"
```
