02. Overview

Repository Structure

This GitHub repository comprises two components:

1. ETL: This data pipeline extracts data from both (a) manually imported data sources and (b) GovData360 API. It then transforms the extracted data through (a) data quality control, (b) rescaling of indicators and (c) application of Closeness-to-Frontier methodology. Finally, the data is loaded into a shared folder, for future use.
2. CLIAR Dashboard: Developed in RShiny, this dashboard provides development practitioners with institutional indicators for analysis. The dashboard is open-source, and feeds on the data loaded from the ETL process.

Directories

├───app
│   ├───auxiliary
│   ├───data
│   └───www
├───code
│   └───notebook
└───data
    ├───clean
    ├───final
    └───raw
        ├───BTI
        ├───CBI
        │   ├───Garriga2023
        │   └───Romelli2022
        ├───gtmi
        ├───VDEM_full_v13
        └───WJP

Each one of these components is mapped onto their respective folders.

1. code: This folder contains the code required for the data ETL. It contains a master.R file that reproduces each and every step in the data pipeline.
2. app: This folder contains the code required for deploying the CLIAR Dashboard. It comprises two key code files, server.R and ui.R, alongside auxiliary functions and www assets.
3. data: This folder contains three separate folders: (a) raw, the input files required to initiate the ETL, (b) clean, intermediate outputs of the ETL used in the pipeline, and (c) final, the outputs of the data pipeline which are loaded into the dashboard.