Reproducibility + organization

Project
Modified

September 29, 2025

All written work should be reproducible, and the GitHub repo should be neatly organized.

Evaluation criteria

Category Less developed projects Typical projects
Reproducibility (code) Required files are missing. Quarto files do not render successfully (except for if a package needs to be installed). All required files are provided. Project files (e.g. Quarto, Shiny apps, R scripts) render without issues and reproduce the necessary outputs.
Reproducibility (packages) renv.lock file does not include all required packages. External users have to manually install packages in order to get code to evaluate. renv.lock includes all required packages. Manual package installation is not required to render any code in the repo (e.g. Quarto documents, R scripts).
Data documentation Codebook is missing. No local copies of data files. All datasets are stored in a data folder, a codebook is provided, and a local copy of the data file is used in the code where needed.
File organization/readability Documents lack a clear structure. There are extraneous materials in the repo and/or files are not clearly organized. Documents (Quarto files and R scripts) are well structured and easy to follow. No extraneous materials.