brycewang-stanford/Auto-Empirical-Research-Skills / skills/11-James-Traina-compound-science/skills/reproducible-pipelines
reproducible-pipelines
VerifiedThis skill covers reproducible research pipelines and replication packages. Use when the user is setting up a research project directory structure, configuring workflow managers (Make, Snakemake, DVC), managing computational environments, preparing replication packages for journal submission, or debugging reproducibility failures. Triggers on "reproducible", "replication package", "Makefile", "Snakemake", "DVC", "pipeline", "workflow manager", "data versioning", "conda environment", "Docker", "seed management", "AEA data editor", "replication", "project structure", or "submission checklist".
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 12.9 KB |
| references/environment-and-seeds.md | markdown | 4.9 KB |
| references/replication-package.md | markdown | 3.3 KB |
| references/stata-and-crosslang.md | markdown | 7.1 KB |
references/replication-package.md
View on GitHub# Replication Package Standards
## AEA Data Editor Requirements
The AEA (American Economic Association) has the most detailed replication requirements. Following these satisfies most other journals too.
**Required components:**
1. **README.md** — Must include:
- Data availability statement (where to obtain each dataset)
- Computational requirements (time, memory, software)
- Instructions to reproduce all results
- List of all tables and figures with the script that produces each
2. **Data citations** — Cite every dataset used, including:
- Provider and access conditions
- DOI or persistent URL
- Date accessed
- Any restrictions on redistribution
3. **Code** — Must produce every number in the paper:
- Every table (including appendix tables)
- Every figure
- Every in-text statistic ("We find a 3.2% effect...")
4. **License** — Include a license file (typically MIT or CC-BY for code)
## README Template
```markdown
# Replication Package for "[Paper Title]"
## Authors
[Names and affiliations]
## Data Availability
| Dataset | Source | Access | Included |
|---------|--------|--------|----------|
| CPS March Supplement | IPUMS | Public (registration) | No — download from [URL] |
| State policy dates | Hand-collected | — | Yes (`data/raw/policy_dates.csv`) |
### Instructions for restricted data
[If any data requires DUA or restricted access, explain the process]
## Computational Requirements
- **Software:** Python 3.11, packages in `environment.yml`
- **Hardware:** [X] GB RAM, [Y] CPU hours
- **OS:** Tested on Ubuntu 22.04 and macOS 14
## Instructions
\`\`\`bash
# 1. Set up environment
conda env create -f environment.yml
conda activate my-project
# 2. Obtain data
# Download CPS data from [URL] to data/raw/
# 3. Run full pipeline
make all
# Expected runtime: ~[X] hours on [hardware description]
\`\`\`
## Output Map
| Output | Script | Table/Figure |
|--------|--------|-------------|
| `output/tables/main_results.tex` | `code/03_estimate.py` | Table 1 |
| `output/tables/robustness.tex` | `code/04_robustness.py` | Table 2 |
| `output/figures/event_study.pdf` | `code/05_tables_figures.py` | Figure 1 |
```
## Pre-Submission Checklist
Run this before submitting the replication package:
- [ ] **Clean build**: `make clean && make all` succeeds from scratch
- [ ] **Fresh environment**: Create environment from `environment.yml` on a clean machine; all packages install
- [ ] **Data documentation**: Every raw data file has source, access instructions, and citation
- [ ] **Output map**: Every table, figure, and in-text statistic mapped to a script
- [ ] **No absolute paths**: `grep -r '/Users\|/home\|C:\\' code/` returns nothing
- [ ] **No manual steps**: Every intermediate file is produced by code, not hand-edited
- [ ] **Seeds documented**: Master seed stated in README; all stochastic code is seeded
- [ ] **Runtime estimate**: README states expected runtime and hardware requirements
- [ ] **License**: LICENSE file included
- [ ] **Sensitive data**: No IRB-restricted or proprietary data included without authorization
- [ ] **Large files**: Data files either included (if small + redistributable) or documented (if large/restricted)
- [ ] **Version pinned**: `environment.yml` or `requirements.txt` has exact version numbers
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deployment | Stars: 323k | Updated | Claude CodeCodex | Verified | Install |
| xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |