stars-reproduce-kim-2021

Assessing the computational reproducibility of Kim et al. 2021 as part of STARS.

https://github.com/pythonhealthdatascience/stars-reproduce-kim-2021

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 9 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.1%) to scientific vocabulary

Keywords

abdominal-aortic-aneurysm aneurysm covid-19 discrete-event-simulation nhs open-science quarto r reproducibility reproducible-research ruptures scenario-analysis screening simulation
Last synced: 4 months ago · JSON representation ·

Repository

Assessing the computational reproducibility of Kim et al. 2021 as part of STARS.

Basic Info
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 3
Topics
abdominal-aortic-aneurysm aneurysm covid-19 discrete-event-simulation nhs open-science quarto r reproducibility reproducible-research ruptures scenario-analysis screening simulation
Created over 1 year ago · Last pushed 12 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

Kim et al. 2021 computational reproducibility assessment STARS

DOI

This repository forms part of work package 1 on the project STARS: Sharing Tools and Artefacts for Reproducible Simulations. It assesses the computational reproducibility of:

Kim LG, Sweeting MJ, Armer M, Jacomelli J, Nasim A, Harrison SC. Modelling the impact of changes to abdominal aortic aneurysm screening and treatment services in England during the COVID-19 pandemic. PLoS ONE 16(6): e0253327 (2021). https://doi.org/10.1371/journal.pone.0253327.

Website

Click here to check out the website for this repository

This website is created using Quarto and hosted using GitHub Pages. It shares everything from this computational reproducibility assessment.

Protocol

The protocol for this work is summarised in the diagram below and archived on Zenodo:

Heather, A., Monks, T., Harper, A., Mustafee, N., & Mayne, A. (2024). Protocol for assessing the computational reproducibility of discrete-event simulation models on STARS. Zenodo. https://doi.org/10.5281/zenodo.12179846.

Workflow

Repository overview

bash ├── .github │ └── workflows │ └── ... ├── evaluation │ └── ... ├── logbook │ └── ... ├── original_study │ └── ... ├── quarto_site │ └── ... ├── reproduction │ └── ... ├── .gitignore ├── CHANGELOG.md ├── CITATION.cff ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── _quarto.yml ├── citation_apalike.apa ├── citation_bibtex.bib ├── index.qmd └── requirements.txt

Key sections: These folders have all the content related to the original study and reproduction...

  • original_study/ - Original study materials (i.e. journal article, supplementary material, code and any other research artefacts).
  • reproduction/ - Reproduction of the simulation model. Once complete, this functions as a research compendium for the model, containing all the code, parameters, outputs and documentation.
  • evaluation/ - Quarto documents from the evaluation of computational reproducibility. This includes the scope, assessment of reproduction success, and comparison of the original study materials against various guidelines, and summary report.
  • logbook/ - Daily record of work on this repository.

Other sections: The remaining files and folders support creation of the Quarto site to share the reproduction, or are other files important to the repository (e.g. README, LICENSE, .gitignore)...

  • .github/workflows/ - GitHub actions.
  • quarto_site/ - A Quarto website is used to share information from this repository (including the original study, reproduced model, and reproducibility evaluation). This folder contains any additional files required for creation of the site that do not otherwise belong in the other folders.
  • .gitignore - Untracked files.
  • CHANGELOG.md - Description of changes between GitHub releases and the associated versions on Zenodo.
  • CITATION.cff - Instructions for citing this repository, created using CFF INIT.
  • CONTRIBUTING.md - Contribution instructions for repository.
  • LICENSE - Details of the license for this work.
  • README.md - Description for this repository. You'll find a seperate README for the model within the reproduction/ folder, and potentially also the original_study/ folder if a README was created by the original study authors.
  • _quarto.yml - Set-up instructions for the Quarto website.
  • citation_apalike.bib - APA citation generated from CITATION.cff.
  • citation_bibtex.bib - Bibtex citation generated from CITATION.cff.
  • index.qmd - Home page for the Quarto website.
  • requirements.txt - Environment for creation of Quarto site (used by .github/workflows/quarto_publish.yaml).

Citation

Please cite the archived version of this repository on Zenodo:

Heather, A., Monks, T., & Harper, A. (2025). Kim et al. 2021 computational reproducibility assessment. Zenodo. https://doi.org/10.5281/zenodo.13121136

You can also cite the repository on GitHub. Please refer to the citation file CITATION.cff, and the auto-generated alternatives citation_apalike.apa and citation_bibtex.bib.

License

This repository is licensed under the GNU Lesser General Public License v3.0.

This is aligned with the original study, who also licensed their work under the GNU Lesser General Public License v3.0.

Funding

This work is supported by the Medical Research Council [grant number MR/Z503915/1].

Owner

  • Name: pythonhealthdatascience
  • Login: pythonhealthdatascience
  • Kind: organization

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: 'Kim et al. 2021 computational reproducibility assessment'
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Amy
    family-names: Heather
    email: a.heather2@exeter.ac.uk
    affiliation: University of Exeter Medical School, Exeter, UK
    orcid: 'https://orcid.org/0000-0002-6596-3479'
  - given-names: Thomas
    family-names: Monks
    email: t.m.w.monks@exeter.ac.uk
    affiliation: University of Exeter Medical School, Exeter, UK
    orcid: 'https://orcid.org/0000-0003-2631-4481'
  - given-names: Alison
    family-names: Harper
    email: a.l.harper@exeter.ac.uk
    affiliation: University of Exeter Business School, Exeter, UK
    orcid: 'https://orcid.org/0000-0001-5274-5037'
repository-code: >-
  https://github.com/pythonhealthdatascience/stars-reproduce-kim-2021
abstract: >-
  This repository forms part of work package 1 on the project STARS: Sharing
  Tools and Artefacts for Reproducible Simulations. It assesses the
  computational reproducibility of: Kim LG, Sweeting MJ, Armer M, Jacomelli J,
  Nasim A, Harrison SC. Modelling the impact of changes to abdominal aortic
  aneurysm screening and treatment services in England during the COVID-19
  pandemic. PLoS ONE 16(6): e0253327 (2021).
  https://doi.org/10.1371/journal.pone.0253327.
license: LGPL-3.0
# TODO: Manually update with each GitHub release (start with 0.1.0)
version: '1.0.0'
date-released: '2025-01-09'

GitHub Events

Total
  • Release event: 1
  • Push event: 6
  • Create event: 1
Last Year
  • Release event: 1
  • Push event: 6
  • Create event: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/cff_convert.yaml actions
  • actions/checkout v4 composite
  • citation-file-format/cffconvert-github-action 2.0.0 composite
.github/workflows/cff_validation.yaml actions
  • actions/checkout v3 composite
  • dieghernan/cff-validator v3 composite
.github/workflows/docker_ghr.yaml actions
  • actions/checkout v3 composite
  • docker/login-action v1 composite
.github/workflows/quarto_publish.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • quarto-dev/quarto-actions/publish v2 composite
  • quarto-dev/quarto-actions/setup v2 composite
requirements.txt pypi
  • jupyter ==1.0.0
  • matplotlib ==3.9.1
  • pandas ==2.2.2
  • plotly ==5.22.0
  • tenacity ==8.3.0
reproduction/DESCRIPTION cran
  • R * depends
  • Rcpp * imports
  • doParallel * imports
  • dplyr * imports
  • expm * imports
  • foreach * imports
  • ggplot2 * imports
  • iterators * imports
  • msm * imports
  • rmarkdown * imports
  • tidyr * imports
reproduction/docker/Dockerfile docker
  • rocker/rstudio 4.4.1 build