Implications
Contents
Implications#
Reviewers#
Outside of journals that offer formal RCR style review initiatives, reviewers can still improve the quality of DES model sharing within health and medicine by encouraging authors to follow best practice. Naturally the reviewers of clinical studies, methodology and health service problems using DES models will have different technical background and knowledge. We also acknowledge that this is an optional activity for reviewers. We therefore propose two levels of light touch review that a study referee may consider when authors of healthcare DES studies cite a shared version of the computer model.
Open scholarship review#
Non-technical reviewers should focus on the open scholarship of the DES model. Others have recommended that code should enhance study reporting and not be a requirement [Eddy et al., 2012, Monks et al., 2019]. We agree with this position and, if already not included, an open scholarship review could begin by asking authors to include and cite a reporting checklist such as STRESS-DES [Monks et al., 2019] to improve the documentation and explanation of models and data.
Our results show that reviewers can improve on this existing base level of open scholarship by encouraging authors to deposit their computer model in an open science archive (for example, their home institution or external archive such as Zenodo or OSF). Reviewers should favour this option over and above journal supplementary material, which is unreliable. We found one instance where authors claim a model is available as supplementary material, but the journal did not provide a link. Open science repositories mint a DOI, for citation and findability, and provides guarantees on persistence long term. Reviewer’s can boost findability of the models by asking authors to include their ORCID details as meta data wherever the model is deposited.
Where necessary, reviewers should also ask authors to provide an open license with their model. In our study we found that authors provided a mix of open licenses. Appropriate choices used by studies included in our review included the MIT license, GPL-3 and BSD-3. The appropriate license will depend on the project and what software has been used. Reviewers could signpost authors to journal guidelines (if applicable) or license guides such as https://choosealicense.com/ to support decisions.
Lastly, reviewers should ask authors to provide basic steps to use and run their DES models. This does not need to include a detailed peer review, but instructions should be visible for open scholarship.
The vast majority of DES health models we found were published outside of ACM journals, and, at the time of writing, authors did not have an opportunity to apply for an RCR review, or receive a badge. Although no badge will be issued, a reviewer making our simple open scholarship recommendations can support DES healthcare authors to meet requirements of the ACM RCR artifact available badge, and begin to work towards meeting the requirements of an RCR artifact evaluated functional badge.
Longevity review#
Given our best practice study findings, more technical reviewers should still prioritise our recommendations for open scholarship. Long term maintainability and reuse of code based models can be maximised through the use of formal dependency management tools. The exact nature of these tools depends on the language used. R and Python were common tools used for DES in our study. Tools that resolve and install dependencies such as renv
and conda
can be used here, respectively. For DES models developed in commercial software, reporting guidelines that include items for software should be followed. For example, The Strengthening the Reporting of Empirical Simulation Studies for DES (STRESS-DES) includes a section on software environment.
Such a review does not guarantee the ability to replicate the results in a paper, but we argue improves the chances of artifacts being functional for others to execute with minimal reviewer effort. For example, instead of directly testing model dependencies, reviewers could ask authors to “confirm the method that has been used to manage software dependencies in your study”.
Researchers#
Researchers who wish to share their model artifacts will want to minimise time and effort. To mitigate end of study time constraints (e.g. due to funding or need to publish results), and increase sharing quality, health researchers should consider open working practices from day one of their study [University of Exeter et al., 2023]. For researchers using FOSS tools to build models, this could be to setup a GitHub repository (or other cloud version control) workflow. Many guides exist and are free to access; for example, from Software Carpentry (\url{https://swcarpentry.github.io/git-novice/}). Repositories can be initially setup as private if needed. Raw study data, and patient records, should not be stored online. However, aggregate simulation model parameters (either real of synthetic), such as those for statistical distributions, could be included. Authors may wish to consult our best practice audit criteria to support their sharing. For example, to include an open license and deposit in a open science repository in order to mint a DOI.
We also note that many DES studies are conducted using propriety software e.g., Arena, with a minority using FOSS packages such as SimPy. While training and time is a consideration in all studies, we encourage researchers who wish to share their models to consider a FOSS simulation tool to enable health services such as the NHS to easily take up and use their work without financial or nuanced licensing blocks. If the upward trend of model sharing continues there will be more example models for researchers to learn from to build their own.
Funders#
The results of our study complement the findings of the UK’s Goldacre review into using health data to support research and analysis [Goldacre and Morely, 2022]. I.e. funders should incentivise researchers to share their DES models. We echo Goldacre’s call for “UKRI and/or NIHR to launch an open funding call specifically for open code projects in health data science” [Goldacre and Morely, 2022]. These specific funders are UK based, but could equally apply internationally. One addition to Goldacre’s recommendations, in context of our DES findings, is that funders could encourage or require researchers to make use of well maintained FOSS simulation tools that facilitate open working and reuse. This latter requirement could assist in raising the proportion of Covid-19 DES studies where computer models are shared. Lastly, given that time, effort, quality, and knowledge are all issues in sharing DES model artifacts, funders should support work that has the potential for new innovation. This might be to improve quality by standardising computational notebooks such as that proposed by TRACE [Ayllón et al., 2021].
References#
- ARG+21
Daniel Ayllón, Steven F. Railsback, Cara Gallagher, Jacqueline Augusiak, Hans Baveco, Uta Berger, Sandrine Charles, Romina Martin, Andreas Focks, Nika Galic, Chun Liu, E. Emiel van Loon, Jacob Nabe-Nielsen, Cyril Piou, J. Gareth Polhill, Thomas G. Preuss, Viktoriia Radchuk, Amelie Schmolke, Julita Stadnicka-Michalak, Pernille Thorbek, and Volker Grimm. Keeping modelling notebooks with TRACE: Good for you and good for environmental research and management support. Environmental Modelling & Software, 136:104932, February 2021. URL: https://www.sciencedirect.com/science/article/pii/S1364815220309890 (visited on 2023-04-25), doi:10.1016/j.envsoft.2020.104932.
- EHC+12
David M. Eddy, William Hollingworth, J. Jaime Caro, Joel Tsevat, Kathryn M. McDonald, and John B. Wong. Model transparency and validation: a report of the ispor-smdm modeling good research practices task force–7. Medical Decision Making, 32(5):733–743, 2012. PMID: 22990088. URL: https://doi.org/10.1177/0272989X12454579, arXiv:https://doi.org/10.1177/0272989X12454579, doi:10.1177/0272989X12454579.
- GM22(1,2)
B Goldacre and J Morely. Better, broader, safer: using health data for research and analysis. A review commissioned by the Secretary of State for Health and Social Care. Department of Health and Social Care., 2022. URL: https://www.gov.uk/government/publications/better-broader-safer-using-health-data-for-research-and-analysis.
- MCO+19(1,2)
Thomas Monks, Christine SM Currie, Bhakti Stephan Onggo, Stewart Robinson, Martin Kunc, and Simon JE Taylor. Strengthening the reporting of empirical simulation studies: introducing the stress guidelines. Journal of Simulation, 13(1):55–67, 2019.
- UniversityoExeterHMUniversityoExeter23
University of Exeter, Alison Harper, Thomas Monks, and University of Exeter. A Framework to Share Healthcare Simulations on the Web Using Free and Open Source Tools and Python. In Proceedings of SW21 The OR Society Simulation Workshop, 250–260. Operational Research Society, March 2023. URL: https://www.theorsociety.com/media/7313/doiorg1036819sw23030.pdf (visited on 2023-05-11), doi:10.36819/SW23.030.