Skip to content

REPLICATION.md

Latest commit

 

History

History
74 lines (56 loc) · 2.54 KB

REPLICATION.md

File metadata and controls

74 lines (56 loc) · 2.54 KB
Raw

Replication Package README

Project: Version: Prepared by:

1. Overview

This package reproduces the tables and figures in . Start from the master script listed below and follow the stage order in the program map.

  • Master script: run_all.sh / master.do / Makefile target
  • Analysis backend: python-statspai / stata / r
  • Backend version report: 00_meta/analysis_backend.md
  • Sample and estimand audit: 02_data/sample_audit.md
  • Design risk ledger: 03_analysis/design_risk_ledger.md
  • Expected wall-clock time:
  • Expected disk use:
  • Operating system and hardware:

2. Data Availability and Provenance

Data source Public / restricted / confidential Access path Cost / approval time Redistribution allowed? Raw location or fetch script
<URL/procedure> <cost/time> yes/no 02_data/raw/ or 02_data/<fetch_script>

Legitimate access statement:

  • Authors had lawful access to every source listed above:
  • Data use agreement / license restrictions:
  • IRB or ethics approval / exemption:
  • PII or confidential fields included in the public package: no

3. Package Contents

Path Purpose
02_data/ Raw access scripts, cleaning scripts, codebook, analysis data
02_data/sample_audit.md Sample construction flow, estimand alignment, missingness/balance/overlap checks
03_analysis/ Estimation scripts, diagnostics, robustness artifacts
03_analysis/design_risk_ledger.md Identification threats, selective-reporting risks, external-validity boundaries, and claim consequences
04_results/ Tables and figures generated by scripts
09_submission/DAS.md Data availability statement

4. Computational Requirements

  • Software versions:
  • Package versions:
  • Stata/R/Python backend details:
  • Random seeds:
  • External services or credentials needed:
  • Steps that require restricted data access:

5. Instructions to Replicators

  1. Obtain any restricted data listed in Section 2.
  2. Install software and packages listed in Section 4.
  3. Run the master script from the package root.
  4. Compare generated outputs against Section 6.

6. Program to Output Map

Exhibit Output path Generating script Notes
Table 1 04_results/table1.tex 03_analysis/<script>:
Figure 1 04_results/figure1.png 03_analysis/<script>:

7. Known Limits

  • Non-public data omissions:
  • Manual steps that remain:
  • Runtime fallback used:
  • Remaining design-risk boundaries:
  • Last rebuild check: