Quickstart

This is the shortest supported path for using the repo.

Preconditions

• Run commands from the repository root.
• Have R available locally.
• Install the minimal repo dependency used by validation:

install.packages("yaml")

Create A New Market/KPI

Rscript scripts/scaffold_market.R IT store_visits

This creates:

markets/IT/store_visits/

Fill In The Market Folder

At minimum:

1. update config.yml
2. implement transform.R
3. implement decomp.R
4. implement build.R
5. update the market README.md
6. record exact validated runtime versions in versions.lock

Validate

Validate one market:

Rscript scripts/validate_market.R markets/IT/store_visits

Validate all migrated markets:

Rscript scripts/validate_all.R

Build

Rscript scripts/build_market.R markets/IT/store_visits

Submit

1. commit the market changes
2. open a pull request
3. product/engineering reviews for mergeability and standards

What This Does Not Yet Guarantee

The current scaffold enforces structure, config shape, and forbidden local-path patterns. Full runtime transform/predict/decomp/build verification is still a next-step enhancement once real market logic is migrated.