# onsdigital/statistical-methods-library architecture

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

- Interactive diagram: https://gitdiagram.com/onsdigital/statistical-methods-library
- Repository: https://github.com/onsdigital/statistical-methods-library

## Overview

##### Main Components

a. Core Statistical Modules:
- Estimation Module
- Imputation Module
- Outliering Module
- Utilities Module

b. Testing Infrastructure:
- Test Fixtures
- Methodology Test Scenarios
- Unit Tests

**┌─────────────────────────────────────────────┐**
- Statistical Methods API          │
- ┘

**┌─────────────┐ ┌─────────────┐ ┌─────────────┐**
- Estimation  │ │ Imputation  │ │ Outliering  │
- Module    │ │   Module    │ │   Module    │
- ┘ └─────────────┘ └─────────────┘

**┌─────────────────────────────────────────────┐**
- Utilities Module               │
- (Exceptions, Validation, Period Handling)  │
- ┘

##### Detailed Component Breakdown

Estimation Module:
- HT Ratio calculations
- Statistical estimations

Imputation Module:
- Engine component
- Ratio calculators
- Mean of ratios
- Ratio of means

Outliering Module:
- Winsorisation implementation
- Outlier detection and handling

Utilities Module:
- Exception handling
- Period management
- Validation utilities

##### Testing Infrastructure (shown as a separate connected component)
**┌─────────────────────────────────────────────┐**
- Testing Framework               │

- ┌─────────────┐ ┌─────────────┐           │
- Unit Tests │ │ Methodology │           │
- Scenarios  │           │
- ┘ └─────────────┘           │
- ┘

##### Additional Elements

- Configuration management (TOML files)
- CI/CD integration points
- Documentation references

**┌─────────────────────────┐**
- →  Direct Dependency    │
- ⇢  Optional Dependency  │
- ↔  Two-way Interaction  │
- ┘

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Title
    title[Statistical Methods Library - System Architecture]
    style title fill:#f5f5f5,stroke:#333,stroke-width:2px

    %% Main API Layer
    subgraph API
        PublicAPI["Statistical Methods API"]
    end

    %% Core Modules Layer
    subgraph CoreModules
        EstimationModule["Estimation Module"]:::core
        ImputationModule["Imputation Module"]:::core
        OutlieringModule["Outliering Module"]:::core
    end

    %% Estimation Components
    subgraph Estimation
        HTRatio["HT Ratio Component"]:::component
    end

    %% Imputation Components
    subgraph Imputation
        Engine["Engine Component"]:::component
        RatioCalc["Ratio Calculators"]:::component
    end

    %% Outliering Components
    subgraph Outliering
        Winsorisation["Winsorisation Implementation"]:::component
    end

    %% Utilities Layer
    subgraph Utilities
        ExceptionHandling["Exception Handling"]:::util
        PeriodManagement["Period Management"]:::util
        ValidationUtils["Validation Utilities"]:::util
    end

    %% Testing Infrastructure
    subgraph Testing
        UnitTests["Unit Tests"]:::test
        TestFixtures["Test Fixtures"]:::test
        MethodologyTests["Methodology Test Scenarios"]:::test
    end

    %% Relationships
    PublicAPI --> EstimationModule
    PublicAPI --> ImputationModule
    PublicAPI --> OutlieringModule

    EstimationModule --> HTRatio
    ImputationModule --> Engine
    ImputationModule --> RatioCalc
    OutlieringModule --> Winsorisation

    HTRatio --> ValidationUtils
    Engine --> ValidationUtils
    RatioCalc --> ValidationUtils
    Winsorisation --> ValidationUtils

    EstimationModule --> ExceptionHandling
    ImputationModule --> ExceptionHandling
    OutlieringModule --> ExceptionHandling

    EstimationModule --> PeriodManagement
    ImputationModule --> PeriodManagement
    OutlieringModule --> PeriodManagement

    UnitTests -.-> EstimationModule
    UnitTests -.-> ImputationModule
    UnitTests -.-> OutlieringModule
    TestFixtures -.-> UnitTests
    MethodologyTests -.-> UnitTests

    %% Click Events
    click EstimationModule "https://github.com/ONSdigital/statistical-methods-library/tree/main/statistical_methods_library/estimation/"
    click ImputationModule "https://github.com/ONSdigital/statistical-methods-library/tree/main/statistical_methods_library/imputation/"
    click OutlieringModule "https://github.com/ONSdigital/statistical-methods-library/tree/main/statistical_methods_library/outliering/"
    click HTRatio "https://github.com/ONSdigital/statistical-methods-library/blob/main/statistical_methods_library/estimation/ht_ratio.py"
    click Engine "https://github.com/ONSdigital/statistical-methods-library/blob/main/statistical_methods_library/imputation/engine.py"
    click RatioCalc "https://github.com/ONSdigital/statistical-methods-library/blob/main/statistical_methods_library/imputation/ratio_calculators.py"
    click Winsorisation "https://github.com/ONSdigital/statistical-methods-library/blob/main/statistical_methods_library/outliering/winsorisation.py"
    click ExceptionHandling "https://github.com/ONSdigital/statistical-methods-library/blob/main/statistical_methods_library/utilities/exceptions.py"
    click PeriodManagement "https://github.com/ONSdigital/statistical-methods-library/blob/main/statistical_methods_library/utilities/periods.py"
    click ValidationUtils "https://github.com/ONSdigital/statistical-methods-library/blob/main/statistical_methods_library/utilities/validation.py"
    click UnitTests "https://github.com/ONSdigital/statistical-methods-library/tree/main/tests/estimation/"
    click TestFixtures "https://github.com/ONSdigital/statistical-methods-library/tree/main/tests/fixture_data/"
    click MethodologyTests "https://github.com/ONSdigital/statistical-methods-library/tree/main/tests/fixture_data/methodology_scenarios/"

    %% Styling
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef component fill:#64B5F6,stroke:#1565C0,color:white
    classDef util fill:#4CAF50,stroke:#2E7D32,color:white
    classDef test fill:#FFC107,stroke:#FFA000,color:black

    %% Legend
    subgraph Legend
        L1[Core Modules]:::core
        L2[Components]:::component
        L3[Utilities]:::util
        L4[Testing]:::test
        L5["→ Direct Dependency"]
        L6["-.-> Test Dependency"]
    end
```
