Version Control and Review
10.5 Version Control and Review
Reading 1
3 / 8
10.5 Version Control and Review
Reproducible reporting benefits from version control. Version control systems such as Git track changes to scripts and documents. They help teams see what changed, when, and why. Even when a team does not use a full collaborative Git workflow, it should still have a disciplined approach to file versions, script review, and output archiving.
Clinical research teams should avoid filenames such as `final_report_final_revised_latest.docx`. Such names are common because teams need versioning but lack a system. A better approach is to use dated outputs and controlled source files:
```text
reports/
weekly_data_quality_report.qmd
outputs/reports/
weekly_data_quality_report_2026-06-01.html
weekly_data_quality_report_2026-06-08.html
```
The report template remains stable. Rendered outputs are archived by date. If the template changes, the change should be documented and reviewed.
| Control | Purpose |
|---|---|
| Script review | Detect logic errors before routine use |
| Version control | Track changes to code and report templates |
| Output archiving | Preserve what was shared at each reporting date |
| Metadata | Document data export and report generation date |
| Validation checks | Compare report outputs with known counts |
| Approval workflow | Ensure outputs are reviewed before distribution |