# Research project README

Adapt these templates to your discipline, institutional rules and actual project.

## Purpose and version

State purpose, version and whether the data are real or synthetic.

Actual decision, rationale and evidence location: ____________________

## Data origin and rights

Separate provenance, consent and data/code licences.

Actual decision, rationale and evidence location: ____________________

## Environment and dependencies

Record actual system/Python/package versions and optional Quarto requirements.

Actual decision, rationale and evidence location: ____________________

## Ordered execution instructions

List ordered commands from the project folder with inputs/outputs; remove private paths.

Actual decision, rationale and evidence location: ____________________

## Outputs and checks

Document expected files, known-answer checks and failure criteria; old output is not replay.

Actual decision, rationale and evidence location: ____________________

## Limitations and contact

Explain assumptions, environment portability, scientific limits and maintenance.

Actual decision, rationale and evidence location: ____________________

---

## Related example and decision record

Decision workbook and teaching example · 2026-10-06

The completed case is fictional. Its values and decisions are not actual findings; complete your project using relevant permissions, methods and requirements.

- Project: ____________________
- Researcher and role: ____________________
- Date and version: ____________________
- Data seen before the decision: ____________________
- Aim and scope: ____________________

## Completed example

| Stage/decision | Example | Check or action |
| --- | --- | --- |
| Input | synthetic.csv and dictionary | Is the original preserved? |
| Checks | IDs, types, ranges and quality flags | Are invalid inputs explicitly rejected? |
| Execution | research.py from the project folder | Are hidden personal paths avoided? |
| Outputs | CSV, JSON, SVG and hash | Do they match expected results? |
| Scope | Teaching example without causal inference | Are limitations in the README? |

## Complete your own record

| Topic | Actual decision and reason | Evidence link and status |
| --- | --- | --- |
| Input | __________ | __________ |
| Checks | __________ | __________ |
| Execution | __________ | __________ |
| Outputs | __________ | __________ |
| Scope | __________ | __________ |

## Completion checks

- [ ] Deliver a documented execution bundle with known-answer tests.

## Changes and limitations

| Date | Change | Data known at decision time | Reason | Consequence for claim | Reviewer |
| --- | --- | --- | --- | --- | --- |
| __________ | __________ | __________ | __________ | __________ | __________ |

## Sources and further reading

- [Python documentation](https://docs.python.org/3/)
- [JupyterLab — Notebooks](https://jupyterlab.readthedocs.io/en/stable/user/notebook.html)
- [Cornell Data Services — Writing READMEs for Research Data](https://data.research.cornell.edu/data-management/sharing/readme/)

Related guide: https://didgar-research-site1.vercel.app/en/guides/research-programming/