Version v0.0 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.
Programs
Categories:
What are ready4 programs?
Programs can be executed in their current form without the need for additional input data and, unless modified or run interactively (prompting a user for inputs during execution), will always generate the exact same output. They are typically deployed for configuring the run specifications of a computational model, specifying the data to which it will be applied and reporting analysis results.
Why are they useful?
ready4 programs can be used for the following purposes:
- to reproduce a study analysis, in which case you will need access to the original study data, and may also need to modify the program to specify the path to this data from your machine;
- to replicate a study analysis (ie to apply the study algorithm to similar but different input data [this can be a new sample from the same population or, if used for demonstration purposes, fake data representative of the original study dataset]), in which case you will need to modify the program to specify the path to this data; and
- to transfer a study analysis, in which case you use the program as a template to be modified to reflect key differences between the original study and your study.
Current ready4 programs
Currently available ready4 programs are summarised in the below table.
| Program | Release | Date | Description | Source |
|---|---|---|---|---|
| aqol6dmap_fakes | 0.0.9.0 | 02-Mar-2022 | This program generates a purely synthetic (i.e. fake - no trace of any real records) population that is reasonably representative of the input data we used for the utility mapping study described in the article https://doi.org/10.1101/2021.07.07.21260129. | Dev, Archive |
| aqol6dmap_use | 0.1 | 13-Sep-2022 | Apply AQoL-6D Utility Mapping Models To New DataThis release includes minor formatting change and an updated version number. | Dev, Archive |
| dce_sa_analysis | 0.1.1 | 28-Oct-2022 | A self-documenting R Markdown program for analysing responses to a discrete choice experiment exploring the online help-seeking preferences of socially anxious young people. | Dev, Archive |
| dce_sa_design | 0.0.9.3 | 26-Oct-2022 | An R Markdown program to create the experimental design for a Discrete Choice Experiment (DCE) exploring online help seeking in socially anxious young people.This release uses functions from the mychoice R package (https://github.com/ready4-dev/mychoice). | Dev, Archive |
| ttu_lng_aqol6_csp | 0.1 | 16-Sep-2022 | Complete study program to reproduce all steps from data ingest through to results dissemination for a study to map mental health measures to AQoL-6D health utility. | Dev, Archive |
Documentation
ready4 programs are typically self-documenting, meaning that each section of code is integrated with plain English descriptions of the purpose it fulfills. The only programs that are not self-documenting are those whose primary purpose is to produce a document (normally an analysis report). Self-documenting programs and sub-routines will be typically documented as a PDF or HTML render of the RMarkdown source file. This rendered document will be bundled with the program, but in some cases may also be shared in online data repositories.