# huffordlab/nam-genomes architecture

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

- Interactive diagram: https://gitdiagram.com/huffordlab/nam-genomes
- Repository: https://github.com/huffordlab/nam-genomes

## Overview

##### Project’s Main Components
- Data Input & External Resources: Start with raw datasets (e.g., PacBio, Illumina, RNA-Seq data) and external databases (MaizeGDB, CyVerse, Gramene) as your entry points.
- Quality Control: A module consisting of scripts and pipelines for raw-data QC and assembly evaluation (e.g., quality-control folder).
- Genome Assembly & Pseudomolecule Construction: Represent the genome-assembly and agp-generation pipelines as separate components.
- Gene Prediction & Annotation: Include modules like gene-prediction (both ab-initio and evidence-based methods) and the merging of predictions.
- Population Genetics & Association Studies: Illustrate how the abc, GERP, and gwas-vcap modules fit into population genetic analysis.
- Visualization & Reporting: Highlight directories with figures, notebooks, and reporting scripts (e.g., analysis_viz in abc, publication-plots).

##### Relationships & Data Flow
- That processed data and assemblies feed into gene prediction/annotation and other downstream analysis modules.
- That results from individual pipelines (e.g., structural variation, methylation, pan-genomics) may have data visualization and validation steps.
- Demonstrate that many pipelines are executed via workflow managers (such as Snakefiles in the predict and simulations directories), implying an underlying dependency management layer.

##### Architectural Patterns & Tools
- The project is modular, with each analysis task housed in its own folder. This separation resembles a microservices-like pattern in research workflows.
- “pipeline” nature of the design: many directories contain sequential steps (e.g., “submit.sh”, “submit.json”, “run*sh” scripts) typical of batch or high-performance computing workflows.

## Diagram (Mermaid)

```mermaid
flowchart TD
    NAM["NAM-genomes"]:::module
    RD["Raw Data & External Resources"]:::external
    QC["Quality Control"]:::module
    WM["Workflow Manager (Snakefile-driven)"]:::workflow
    GA["Genome Assembly"]:::module
    PC["Pseudomolecule Construction"]:::module
    GP["Gene Prediction & Annotation"]:::module
    CA["Centromere Annotation"]:::analysis
    KN["Knob Analyses"]:::analysis
    ME["Methylation Studies"]:::analysis
    PA["Pan-genome Analysis"]:::analysis
    TE["TE Annotation"]:::analysis
    SV["Structural Variation"]:::analysis

    subgraph "Population Genetics & Association Studies"
        ABC["abc"]:::population
        GERP["GERP"]:::population
        GWAS["GWAS-VCAP"]:::population
    end

    AR["Analysis Results"]:::results
    VRP["Visualization: Publication Plots"]:::visual
    VRA["Visualization: Analysis Viz"]:::visual

    NAM --> RD
    RD --> QC
    QC --> WM
    WM --> GA
    WM --> GP
    GA --> PC
    GA --> GP

    GP --> CA
    GP --> KN
    GP --> ME
    GP --> PA
    GP --> TE
    GP --> SV

    GA --> ABC
    GA --> GERP
    GA --> GWAS

    CA --> AR
    KN --> AR
    ME --> AR
    PA --> AR
    TE --> AR
    SV --> AR
    ABC --> AR
    GERP --> AR
    GWAS --> AR

    AR --> VRP
    AR --> VRA

    click QC "https://github.com/huffordlab/nam-genomes/tree/master/quality-control/"
    click GA "https://github.com/huffordlab/nam-genomes/tree/master/genome-assembly/"
    click PC "https://github.com/huffordlab/nam-genomes/tree/master/agp-generation/"
    click GP "https://github.com/huffordlab/nam-genomes/tree/master/gene-prediction/"
    click CA "https://github.com/huffordlab/nam-genomes/tree/master/centromere_annotation/"
    click KN "https://github.com/huffordlab/nam-genomes/tree/master/knob-analyses/"
    click ME "https://github.com/huffordlab/nam-genomes/tree/master/methylation/"
    click PA "https://github.com/huffordlab/nam-genomes/tree/master/pangenome-analyses/"
    click TE "https://github.com/huffordlab/nam-genomes/tree/master/te-annotation/"
    click SV "https://github.com/huffordlab/nam-genomes/tree/master/structural-variation/"
    click ABC "https://github.com/huffordlab/nam-genomes/tree/master/abc/"
    click GERP "https://github.com/huffordlab/nam-genomes/tree/master/gerp/"
    click GWAS "https://github.com/huffordlab/nam-genomes/tree/master/gwas-vcap/"
    click VRP "https://github.com/huffordlab/nam-genomes/tree/master/publication-plots/"
    click VRA "https://github.com/huffordlab/nam-genomes/tree/master/abc/analysis_viz/"

    classDef external fill:#a3d5ff,stroke:#1f77b4,stroke-width:2px;
    classDef module fill:#c2f0c2,stroke:#228B22,stroke-width:2px;
    classDef workflow fill:#fff7a3,stroke:#ffaa00,stroke-width:2px;
    classDef analysis fill:#ffd1a3,stroke:#ff7f0e,stroke-width:2px;
    classDef population fill:#d1a3ff,stroke:#8a2be2,stroke-width:2px;
    classDef results fill:#f0e68c,stroke:#b8860b,stroke-width:2px;
    classDef visual fill:#d1ecf1,stroke:#17a2b8,stroke-width:2px;
```
