Subroutines (reporting templates)
Subroutines perform part of an analysis and reporting algorithm.
Categories:
What are subroutines?
Sub-routines need to be called by parent programs that supply them with input data. Sub-routines can be called by multiple programs and will produce output that varies based on the input values they are supplied with. They are typically deployed to implement parts of a model’s analysis and reporting algorithm.
Why are they useful?
readyforwhatsnext model subroutines can be used primarily as templates to generate reports. They can be used in three ways:
- to help execute a program or function written by a third party (in which case you probably won’t need to modify the subroutine and may not even be aware that it is being used);
- to help execute a program or function that you write (in which case, you shouldn’t have to modify the subroutine, but may find it useful to customise it to your purposes); and
- to serve as a template for subroutines you write yourself that perform similar tasks (in which case you will be rewriting the subroutine’s code).
Current readyforwhatsnext subroutines
Currently available readyforwhatsnext subroutines are summarised in the below table.
| Subroutine | Release | Date | Description | Source |
|---|---|---|---|---|
| ms_tmpl | 0.1.1.0 | 19-Apr-2022 | A collection of files to provide a template for generating scientific manuscripts describing open source mental health systems models projects that use the ready4 framework.This release is a minor patch to correct an incorrectly specified version number. | Dev , Archive |
| mychoice_results | 0.1 | 07-Nov-2022 | Report results from a Discrete Choice Experiment implemented with the mychoice R package. | Dev, Archive |
| ttu_lng_ss | 0.9.0.1 | 23-Jun-2023 | This sub-routine program extends the R package TTU by providing a toolkit for automatically authoring a first draft of a scientific manuscript from results generated by TTU modules. The program is intended for use and as the last component of TTU’s reporting workflow for utility mapping modelling projects. An example of this workflow is available at: https://doi.org/10.5281/zenodo.6116077 . This program generalises a program that produced the manuscript for a real world study (https://doi.org/10.1101/2021.07.07.21260129). The program can produce manuscripts in PDF / LaTex (example - https://dataverse.harvard.edu/api/access/datafile/4957407) and Word (example - https://dataverse.harvard.edu/api/access/datafile/4957416). It should be noted that the Word output requires some manual editing to adapt section numbering, modify table headers and resize tables to page boundaries.This release fixes a bug that prevented the previous version from rendering. | Dev , Archive |
| ttu_mdl_ctlg | 0.1.0.1 | 18-Jul-2023 | A reporting template for utility mapping models created using the TTU package (https://ready4-dev.github.io/TTU/index.html). This release includes minor bug fixes. | Dev, Archive |
Documentation
readyforhwhatsnext subroutines are currently minimally documented, typically in the form as notes contained in a README file in the source code bundle.
Last modified June 8, 2024: updated vignettes (77a947c)