Use this checklist before publishing a new SimGP release to ensure the software, documentation, and associated research outputs are complete, reproducible, and ready for public distribution.
- Run
source("SimGP_tomato_case_study.R")from a clean R session. - Confirm the simulation completes without errors or warnings.
- Confirm all expected output files are generated.
- Verify that output files are written to the correct directory.
- Compare summary statistics with those reported in the manuscript.
- Confirm results are reproducible using the documented random seed.
- Run all example scripts successfully.
- Review and update
README.md. - Verify installation instructions are correct.
- Confirm repository structure matches the documentation.
- Save
sessionInfo()indocs/sessionInfo.txt. - Update
NEWS.mdwith release notes. - Check all links in the documentation.
- Remove temporary files and test outputs.
- Remove
.Rhistory,.RData, and other local files. - Confirm
.gitignoreexcludes unnecessary files. - Ensure all source files contain appropriate headers.
- Update
CITATION.cffwith the final manuscript citation. - Confirm all authors are listed correctly.
- Verify the selected licence (
LICENSE) is included. - Confirm the licence has been agreed upon by all contributors.
- Create the GitHub release (e.g.,
v1.0.0). - Tag the release in Git.
- Archive the same release in Zenodo.
- Add the Zenodo DOI to:
-
README.md -
CITATION.cff - Manuscript
-
- Clone the repository into a new directory.
- Follow the installation instructions as a first-time user.
- Run the complete workflow successfully.
- Confirm all documentation and example commands work as described.
Release approved by: ______________________
Release version: ___________________________
Release date: ______________________________