# ecogenomics/checkm architecture

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

- Interactive diagram: https://gitdiagram.com/ecogenomics/checkm
- Repository: https://github.com/ecogenomics/checkm

## Overview

##### Main Components

a. Core Processing Components:
- Marker Gene Analysis System
- Genome Quality Assessment Pipeline
- Taxonomic Classification System
- Statistical Analysis Engine
- Plotting System

b. Supporting Components:
- Data Management System
- Configuration System
- Command Line Interface
- Testing Framework

##### Component Relationships

a. Primary Workflows:
**Input Genomes → Marker Gene Detection → Quality Assessment → Results**

b. Supporting Workflows:
**Configuration → Data Loading → Analysis → Visualization**

##### Technical Details

a. File references:
- Main entry point (main.py)
- Core analysis modules
- Utility modules
- Test framework

b. Configuration flow:
- Data configuration
- Version management
- Custom marker sets

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Input
        IG[Input Genomes]
    end

    subgraph "Core Processing Layer"
        MGA["Marker Gene Analysis"]:::core
        GQA["Genome Quality Assessment"]:::core
        TCS["Taxonomic Classification"]:::core
        SAE["Statistical Analysis"]:::core
    end

    subgraph "External Tools"
        HMMER["HMMER"]:::external
        Prodigal["Prodigal"]:::external
        Pplacer["Pplacer"]:::external
    end

    subgraph "Supporting Systems"
        DMS["Data Management"]:::support
        CS["Configuration"]:::support
        CLI["Command Line Interface"]:::support
        PS["Plotting System"]:::support
    end

    subgraph "Testing & Validation"
        TF["Testing Framework"]:::testing
    end

    %% Main Workflow
    IG --> CLI
    CLI --> MGA
    MGA --> GQA
    GQA --> PS
    MGA --> TCS

    %% External Tool Integration
    MGA --> HMMER
    MGA --> Prodigal
    TCS --> Pplacer

    %% Support System Connections
    CS --> MGA
    CS --> GQA
    DMS --> MGA
    DMS --> GQA
    DMS --> TCS
    SAE --> PS

    %% Testing Connections
    TF -.-> MGA
    TF -.-> GQA
    TF -.-> TCS

    %% Click Events
    click MGA "https://github.com/Ecogenomics/CheckM/blob/master/checkm/markerGeneFinder.py"
    click GQA "https://github.com/Ecogenomics/CheckM/blob/master/checkm/binStatistics.py"
    click TCS "https://github.com/Ecogenomics/CheckM/blob/master/checkm/taxonParser.py"
    click PS "https://github.com/Ecogenomics/CheckM/tree/master/checkm/plot"
    click HMMER "https://github.com/Ecogenomics/CheckM/blob/master/checkm/hmmer.py"
    click Prodigal "https://github.com/Ecogenomics/CheckM/blob/master/checkm/prodigal.py"
    click Pplacer "https://github.com/Ecogenomics/CheckM/blob/master/checkm/pplacer.py"
    click DMS "https://github.com/Ecogenomics/CheckM/blob/master/checkm/fileEntity.py"
    click CS "https://github.com/Ecogenomics/CheckM/tree/master/checkm/DATA_CONFIG"
    click CLI "https://github.com/Ecogenomics/CheckM/tree/master/bin/checkm"
    click TF "https://github.com/Ecogenomics/CheckM/tree/master/checkm/test"

    %% Styling
    classDef core fill:#2374f7,stroke:#fff,stroke-width:2px,color:#fff
    classDef external fill:#ffd700,stroke:#fff,stroke-width:2px
    classDef support fill:#48a868,stroke:#fff,stroke-width:2px,color:#fff
    classDef testing fill:#ff6b6b,stroke:#fff,stroke-width:2px,color:#fff

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["External Tools"]:::external
        L3["Support Systems"]:::support
        L4["Testing Components"]:::testing
    end
```
