# cjseven007/foi_analysis architecture

> Architecture diagram of the GitHub repository cjseven007/foi_analysis, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cjseven007/foi_analysis
- Repository: https://github.com/cjseven007/foi_analysis

## Overview

This repository is a reproducible de-dollarisation research pipeline. Its main workflow downloads market and macroeconomic series, cleans and validates them alongside manually entered observations, then produces RQ1 figures and RQ3 portfolio-analysis figures and tables. Separate extractors transform World Gold Council and IMF COFER downloads into analysis inputs. The README also identifies RQ2, but no distinct RQ2 analysis module appears in the supplied tree. Connections below reflect sampled code or README documentation; unsampled analysis details are not inferred.

Main entry points: [`scripts/config.py`](https://github.com/cjseven007/foi_analysis/blob/main/scripts/config.py) (Shared settings), [`data/manual`](https://github.com/cjseven007/foi_analysis/tree/main/data/manual) (Manual observations), [`data/clean`](https://github.com/cjseven007/foi_analysis/tree/main/data/clean) (Analysis datasets), [`scripts/01_download.py`](https://github.com/cjseven007/foi_analysis/blob/main/scripts/01_download.py) (Series downloader)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ingest["Data acquisition"]
  node_downloader["Series downloader<br/>[01_download.py]"]
  node_raw_data[("Raw datasets")]
  node_manual_data[("Manual observations")]
end

subgraph group_prep["Preparation"]
  node_gold_extract["Gold extractor"]
  node_cofer_extract["COFER extractor"]
  node_cleaner["Data cleaner<br/>[02_clean.py]"]
  node_clean_data[("Analysis datasets")]
  node_settings["Shared settings<br/>[config.py]"]
end

subgraph group_research["Research analysis"]
  node_rq1["RQ1 figures<br/>[05_plot_rq1.py]"]
  node_rq3["RQ3 analysis"]
end

subgraph group_outputs["Research outputs"]
  node_figures["Research figures"]
  node_tables["Research tables"]
end

node_researcher(("Researcher"))
node_fred(("FRED"))
node_yahoo(("Yahoo Finance"))
node_wgc["WGC export"]
node_imf["IMF COFER export"]
node_manual_docs["Manual source documents"]

node_researcher -->|"runs"| node_downloader
node_fred -->|"provides series"| node_downloader
node_yahoo -->|"provides prices"| node_downloader
node_downloader -->|"writes downloads"| node_raw_data
node_wgc -->|"input workbook"| node_gold_extract
node_gold_extract -->|"writes gold data"| node_manual_data
node_gold_extract -->|"writes year-end gold"| node_clean_data
node_imf -->|"input CSV"| node_cofer_extract
node_cofer_extract -->|"writes USD share"| node_manual_data
node_cofer_extract -->|"writes composition"| node_clean_data
node_manual_docs -.->|"entered observations"| node_manual_data
node_raw_data -->|"reads raw series"| node_cleaner
node_manual_data -->|"checks observations"| node_cleaner
node_cleaner -->|"writes validated data"| node_clean_data
node_settings -->|"configures paths"| node_downloader
node_settings -->|"configures paths"| node_cleaner
node_settings -->|"configures paths"| node_gold_extract
node_settings -->|"configures paths"| node_cofer_extract
node_settings -->|"configures paths"| node_rq1
node_settings -->|"configures paths"| node_rq3
node_clean_data -->|"reads inputs"| node_rq1
node_manual_data -->|"reads observations"| node_rq1
node_rq1 -->|"writes figures"| node_figures
node_clean_data -->|"reads inputs"| node_rq3
node_rq3 -->|"writes figures"| node_figures
node_rq3 -->|"writes tables"| node_tables

click node_downloader "https://github.com/cjseven007/foi_analysis/blob/main/scripts/01_download.py"
click node_raw_data "https://github.com/cjseven007/foi_analysis/tree/main/data/raw"
click node_manual_data "https://github.com/cjseven007/foi_analysis/tree/main/data/manual"
click node_gold_extract "https://github.com/cjseven007/foi_analysis/blob/main/scripts/03_extract_wgc_gold.py"
click node_cofer_extract "https://github.com/cjseven007/foi_analysis/blob/main/scripts/04_extract_cofer.py"
click node_cleaner "https://github.com/cjseven007/foi_analysis/blob/main/scripts/02_clean.py"
click node_clean_data "https://github.com/cjseven007/foi_analysis/tree/main/data/clean"
click node_settings "https://github.com/cjseven007/foi_analysis/blob/main/scripts/config.py"
click node_rq1 "https://github.com/cjseven007/foi_analysis/blob/main/scripts/05_plot_rq1.py"
click node_rq3 "https://github.com/cjseven007/foi_analysis/blob/main/scripts/rq3/run_rq3_analysis.py"
click node_figures "https://github.com/cjseven007/foi_analysis/tree/main/figures"
click node_tables "https://github.com/cjseven007/foi_analysis/tree/main/tables"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_downloader,node_raw_data,node_manual_data toneBlue
class node_gold_extract,node_cofer_extract,node_cleaner,node_clean_data,node_settings toneAmber
class node_rq1,node_rq3 toneMint
class node_figures,node_tables toneRose
class node_researcher,node_fred,node_yahoo,node_wgc,node_imf,node_manual_docs toneIndigo
```

## Components

### Data acquisition

- [Series downloader](https://github.com/cjseven007/foi_analysis/blob/main/scripts/01_download.py): `scripts/01_download.py`
- [Raw datasets](https://github.com/cjseven007/foi_analysis/tree/main/data/raw): `data/raw`
- [Manual observations](https://github.com/cjseven007/foi_analysis/tree/main/data/manual): `data/manual`

### Preparation

- [Gold extractor](https://github.com/cjseven007/foi_analysis/blob/main/scripts/03_extract_wgc_gold.py): `scripts/03_extract_wgc_gold.py`
- [COFER extractor](https://github.com/cjseven007/foi_analysis/blob/main/scripts/04_extract_cofer.py): `scripts/04_extract_cofer.py`
- [Data cleaner](https://github.com/cjseven007/foi_analysis/blob/main/scripts/02_clean.py): `scripts/02_clean.py`
- [Analysis datasets](https://github.com/cjseven007/foi_analysis/tree/main/data/clean): `data/clean`
- [Shared settings](https://github.com/cjseven007/foi_analysis/blob/main/scripts/config.py): `scripts/config.py`

### Research analysis

- [RQ1 figures](https://github.com/cjseven007/foi_analysis/blob/main/scripts/05_plot_rq1.py): `scripts/05_plot_rq1.py`
- [RQ3 analysis](https://github.com/cjseven007/foi_analysis/blob/main/scripts/rq3/run_rq3_analysis.py): `scripts/rq3/run_rq3_analysis.py`

### Research outputs

- [Research figures](https://github.com/cjseven007/foi_analysis/tree/main/figures): `figures`
- [Research tables](https://github.com/cjseven007/foi_analysis/tree/main/tables): `tables`

### Other components

- **Researcher**
- **FRED**
- **Yahoo Finance**
- **WGC export**
- **IMF COFER export**
- **Manual source documents**

## Connections

- Researcher → Series downloader: runs (evidence: `scripts/01_download.py`)
- FRED → Series downloader: provides series (evidence: `scripts/01_download.py`)
- Yahoo Finance → Series downloader: provides prices (evidence: `scripts/01_download.py`)
- Series downloader → Raw datasets: writes downloads (evidence: `scripts/01_download.py`)
- WGC export → Gold extractor: input workbook (evidence: `scripts/03_extract_wgc_gold.py`)
- Gold extractor → Manual observations: writes gold data (evidence: `scripts/03_extract_wgc_gold.py`)
- Gold extractor → Analysis datasets: writes year-end gold (evidence: `scripts/03_extract_wgc_gold.py`)
- IMF COFER export → COFER extractor: input CSV (evidence: `scripts/04_extract_cofer.py`)
- COFER extractor → Manual observations: writes USD share (evidence: `scripts/04_extract_cofer.py`)
- COFER extractor → Analysis datasets: writes composition (evidence: `scripts/04_extract_cofer.py`)
- Manual source documents → Manual observations: entered observations (evidence: `README.md`)
- Raw datasets → Data cleaner: reads raw series (evidence: `scripts/02_clean.py`)
- Manual observations → Data cleaner: checks observations (evidence: `scripts/02_clean.py`)
- Data cleaner → Analysis datasets: writes validated data (evidence: `scripts/02_clean.py`)
- Shared settings → Series downloader: configures paths (evidence: `scripts/01_download.py`)
- Shared settings → Data cleaner: configures paths (evidence: `scripts/02_clean.py`)
- Shared settings → Gold extractor: configures paths (evidence: `scripts/03_extract_wgc_gold.py`)
- Shared settings → COFER extractor: configures paths (evidence: `scripts/04_extract_cofer.py`)
- Shared settings → RQ1 figures: configures paths (evidence: `scripts/05_plot_rq1.py`)
- Shared settings → RQ3 analysis: configures paths (evidence: `scripts/rq3/run_rq3_analysis.py`)
- Analysis datasets → RQ1 figures: reads inputs (evidence: `scripts/05_plot_rq1.py`)
- Manual observations → RQ1 figures: reads observations (evidence: `scripts/05_plot_rq1.py`)
- RQ1 figures → Research figures: writes figures (evidence: `scripts/05_plot_rq1.py`)
- Analysis datasets → RQ3 analysis: reads inputs (evidence: `scripts/rq3/run_rq3_analysis.py`)
- RQ3 analysis → Research figures: writes figures (evidence: `scripts/rq3/run_rq3_analysis.py`)
- RQ3 analysis → Research tables: writes tables (evidence: `scripts/rq3/run_rq3_analysis.py`)
