Git Product home page Git Product logo

pythonhealthdatascience / stars-reproduce-shoaib-2022 Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 8.66 MB

Assessing the computational reproducibility of Shoaib and Ramamohan 2022 as part of STARS.

Home Page: https://pythonhealthdatascience.github.io/stars-reproduce-shoaib-2022/

License: MIT License

TeX 7.42% Python 13.28% Jupyter Notebook 79.08% Shell 0.14% Dockerfile 0.08%
discrete-event-simulation india open-science reproducibility reproducible-research salabim simulation python

stars-reproduce-shoaib-2022's Introduction

STARS: Computational reproducibility of Shoaib and Ramamohan 2022 STARS

Valid CITATION.cff 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:

Shoaib M, Ramamohan V. Simulation modeling and analysis of primary health center operations. SIMULATION 98(3):183-208. (2022). https://doi.org/10.1177/00375497211030931.

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

├── .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

If you wish to cite this repository, 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 MIT License.

This is aligned with the original study, who also licensed their code under the MIT License.

Funding

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

stars-reproduce-shoaib-2022's People

Contributors

amyheather avatar

Watchers

Tom Monks avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.