# alizurd/airline_loyalty architecture

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

- Interactive diagram: https://gitdiagram.com/alizurd/airline_loyalty
- Repository: https://github.com/alizurd/airline_loyalty

## Overview

##### Main Components
- Data Sources and Storage:
- Raw data files (located in data/raw_data) including CSV files like airline loyalty data dictionaries, calendar, flight_activity, and loyalty_history.
- Processed data files (in data folder like all_together_now.csv, bq_flights.csv, and bq_history.csv) that are likely the outputs or aggregated results of cleaning/processing.

- Data Cleaning / ETL Layer:
- Scripts like code/clean_data_for_bq.R and the cleaning_loyalty_data.R in code/scratch code represent the "Extract, Transform, Load" stage where raw data is prepared for analysis.

- Exploratory Data Analysis (EDA):
- SQL scripts (code/eda.sql and code/scratch code/eda_for_ml.sql) are used to explore relationships and patterns in the data.

- Modeling / Analytics Component:
- The predictive modeling is implemented in code/model.R alongside code snippets for machine learning in code/scratch code/code_snippet_for_ML.R.
- Additional analysis code such as flight.R and loyalty_code.R may encapsulate domain-specific calculations or transformations.

##### Architectural Patterns and Principles
- Layered Architecture:
- Clearly separate data ingestion (raw data), transformation (cleaning/ETL scripts), analysis (EDA scripts), and modeling (machine learning code).
- Modularity:
- The project structure with separate code files (organized in main code folder and scratch code subfolder) indicates a development style where experiments and main pipelines are separated.
- Data Pipeline Flow:
- Data pipeline concept where data moves from storage (CSV files) → cleaning/ETL scripts → database-ready data output → EDA and model training.

##### Technologies and Frameworks
- R: For data cleaning and the modeling code (R scripts).
- SQL: For performing exploratory data analysis and possibly querying aggregated data.
- File-based Data Storage: The CSV files serve as both input and output artifacts in the pipeline.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Data Ingestion Layer
    subgraph "Data Ingestion"
        RD["Raw Data Repository"]:::storage
        click RD "https://github.com/alizurd/airline_loyalty/tree/main/data/raw_data"
    end

    %% ETL Layer
    subgraph "Data Cleaning & ETL"
        ETL1["ETL - Primary Script: clean_data_for_bq.R"]:::processing
        click ETL1 "https://github.com/alizurd/airline_loyalty/blob/main/code/clean_data_for_bq.R"
        ETL2["ETL - Experimental Script: cleaning_loyalty_data.R"]:::processing
        click ETL2 "https://github.com/alizurd/airline_loyalty/blob/main/code/scratch code/cleaning_loyalty_data.R"
    end

    %% Processed Data Layer
    subgraph "Processed Data Store"
        PD["Processed Data Store (CSV)"]:::storage
        click PD "https://github.com/alizurd/airline_loyalty/tree/main/data"
    end

    %% Exploratory Data Analysis Layer
    subgraph "Exploratory Data Analysis"
        EDA1["EDA - SQL Script: eda.sql"]:::query
        click EDA1 "https://github.com/alizurd/airline_loyalty/blob/main/code/eda.sql"
        EDA2["EDA - Supplementary SQL Script: eda_for_ml.sql"]:::query
        click EDA2 "https://github.com/alizurd/airline_loyalty/blob/main/code/scratch code/eda_for_ml.sql"
    end

    %% Modeling & Prediction Layer
    subgraph "Modeling & Prediction"
        M1["Modeling - Main Script: model.R"]:::processing
        click M1 "https://github.com/alizurd/airline_loyalty/blob/main/code/model.R"
        M2["ML Code Snippet: code_snippet_for_ML.R"]:::processing
        click M2 "https://github.com/alizurd/airline_loyalty/blob/main/code/scratch code/code_snippet_for_ML.R"
        M3["Flight Analysis: flight.R"]:::processing
        click M3 "https://github.com/alizurd/airline_loyalty/blob/main/code/scratch code/flight.R"
        M4["Loyalty Analysis: loyalty_code.R"]:::processing
        click M4 "https://github.com/alizurd/airline_loyalty/blob/main/code/scratch code/loyalty_code.R"
    end

    %% Data Flow Connections
    RD -->|"ingests"| ETL1
    RD -->|"ingests"| ETL2
    ETL1 -->|"outputs"| PD
    ETL2 -->|"outputs"| PD
    PD -->|"feeds"| EDA1
    PD -->|"feeds"| EDA2
    PD -->|"feeds"| M1
    PD -->|"feeds"| M2
    PD -->|"feeds"| M3
    PD -->|"feeds"| M4

    %% Styles
    classDef storage fill:#ffcccc,stroke:#333,stroke-width:2px;
    classDef processing fill:#ccffcc,stroke:#333,stroke-width:2px;
    classDef query fill:#cce5ff,stroke:#333,stroke-width:2px;
```
