Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. Dates formatted as YYYY-MM-DD as per ISO standard.
v1.0.4 - 2024-07-26
Contributors: Amy Heather
Minor improvements following the third reproducibility assessment (Lim et al. 2020).
Changed
- Add references to .yaml header in
reproduction_report.qmd
,reproduction_success.qmd
andstudy_publication.qmd
and set echo as false forscope.qmd
- Amended grammar in
reporting.qmd
bullet list - Updated
references.bib
v1.0.3 - 2024-07-19
Contributors: Amy Heather
Minor improvements following the second reproducibility assessment (Huang et al. 2019).
Added
- Interactive and non-interactive time-to-completion figures add to
reproduction_success.qmd
, withtime_to_complete.py
producing figures - Add R-related items to
.gitignore
- Add option to not show limit on time from
calculate_times()
Changed
- Corrected spelling of “artefacts” in
badges.qmd
and add sentence to cite original study inscope.qmd
- Updated
references.bib
- Add
matplotlib
torequirements.txt
v1.0.2 - 2024-07-03
Contributors: Amy Heather
Minor improvements following the first reproducibility assessment (Shoaib and Ramamohan 2022).
Added
- Template page (
reflections.qmd
) for reflections on facilitators and barriers to reproduction, and for full list of troubleshooting steps
Changed
- Add
.vscode/
to.gitignore
- Add citation to protocol on quarto site home page
- Order of criteria in
badges.qmd
(so it is a consistent order between the dictionary of criteria names and results, making it easier when conducting the assessment to look between the two) - Amended
TODO:
comments in CHANGELOG and GHCR GitHub action - Add missing
<!--- -->
marker inartefacts.qmd
- Improved the “succesfully reproduced” template sentence in
reproduction_report.qmd
v1.0.1 - 2024-06-19
Contributors: Amy Heather
Fix to citation file to prevent error on Zenodo.
Fixed
- Completed
CITATION.cff
to reflect this repository (rather than to be a blank example), to prevent error when syncing with Zenodo
v1.0.0 0 2024-06-19
Contributors: Amy Heather, with review of the protocol and associated artefacts (such as this template) from Tom Monks, Alison Harper and Nav Mustafee
Initial release of template repository. 🌱