From dad75063fc51b40264edbe22e3d95962268c68d7 Mon Sep 17 00:00:00 2001 From: Armin Date: Mon, 15 Jun 2026 17:40:05 +0200 Subject: [PATCH] Clarify source setup documentation --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cff83bf..8cb26fb 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Code and processed model inputs for generating two-dimensional party-position es ## Repository contents -- `data-setup/` — source download and rebuild workflow for raw files that cannot be redistributed here. +- `data-setup/` — source-file checks and rebuild workflow for raw files that cannot be redistributed here. - `src/julia/` — Stan data preparation, model fitting, post-estimation, enrichment, and validation. - `models/` — Stan model specification. - `data/` — five processed party-level inputs used by the Julia/Stan model. @@ -22,7 +22,7 @@ The public repository does **not** contain the original raw/source files. Severa 1. committed model-ready inputs in `data/`, sufficient for fitting the Julia/Stan model; and 2. `data-setup/`, a workflow that downloads or checks raw sources and rebuilds comparable model-ready inputs locally. -`data-setup/` automatically downloads all script-accessible sources: +`data-setup/` documents the required source files and checks locally supplied sources for: - PolDem - PartyFacts crosswalk @@ -33,7 +33,7 @@ The public repository does **not** contain the original raw/source files. Severa Two inputs require user-provided access/material: -- **Manifesto Project**: users must provide their own Manifesto Project API key via `MANIFESTO_API_KEY` or `PARTY2D_MANIFESTO_API_KEY`. +- **Manifesto Project**: users must obtain the source data through their own Manifesto Project access. - **Morgan historical expert data**: `morgan_positions_raw.csv` is not publicly downloadable; it can be provided on request and should be placed locally under `_local/raw/morgan/`. The setup workflow never overwrites committed files in `data/`. See `data-setup/README.md` and `docs/RAW_DATA_SOURCES.md` for exact commands and source details. @@ -44,7 +44,7 @@ Run the full source-data setup workflow with: bash data-setup/run_data_setup.sh ``` -This downloads script-accessible source files, checks required local files, rebuilds model-ready inputs locally, and writes a comparison report. Manifesto Project requires your own API key, and the Morgan OCR/transcription file can be provided on request. +This checks required local files, rebuilds model-ready inputs locally, and writes a comparison report. Manifesto Project requires your own provider access, and the Morgan OCR/transcription file can be provided on request. ## Running the pipeline