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.
Finding modules and sub-modules
Categories:
You can search for ready4 modules and sub-modules using tools from the ready4 R package.
To search for themed collections of modules, you can review the current list of module libraries.
An itemised list of individual ready4 model modules and sub-modules can be generated by scraping the websites of these libraries make_modules_tb
function (this may take a couple of minutes).
modules_tb <- make_modules_tb()
A slightly quicker method to achieve a similar (but potentially less up to date) result is to use the get_modules_tb
function.
# Not run
# modules_tb <- get_modules_tb()
If you wish to display the table of modules as HTML, you can use the print_modules
function. You can choose to display only ready4 sub-modules (which always use R’s “S3” class type).
print_modules(modules_tb,
what_1L_chr = "S3")
Class | Description | Examples |
---|---|---|
specific_models | Candidate models lookup table | |
specific_predictors | Candidate predictors lookup table | |
youthvars_aqol6d_adol | youthvars S3 class for Assessment of Quality of Life Six Dimension Health Utility - Adolescent Version (AQoL6d Adolescent)) | 1 |
youthvars_bads | youthvars S3 class for Behavioural Activation for Depression Scale (BADS) scores | 1 |
youthvars_gad7 | youthvars S3 class for Generalised Anxiety Disorder Scale (GAD-7) scores | 1 |
youthvars_k6 | youthvars S3 class for Kessler Psychological Distress Scale (K6) - US Scoring System scores | 1 |
youthvars_oasis | youthvars S3 class for Overall Anxiety Severity and Impairment Scale (OASIS) scores | 1 |
youthvars_phq9 | youthvars S3 class for Patient Health Questionnaire (PHQ-9) scores | 1 |
youthvars_scared | youthvars S3 class for Screen for Child Anxiety Related Disorders (SCARED) scores | 1 |
youthvars_sofas | youthvars S3 class for Social and Occupational Functioning Assessment Scale (SOFAS) | 1 |
To display only ready4 modules, restrict returns to R’s “S4” class type.
print_modules(modules_tb,
what_1L_chr = "S4")
Class | Description | Examples |
---|---|---|
ScorzAqol6 | A dataset and metadata to support implementation of an AQoL-6D scoring algorithm | |
ScorzAqol6Adol | A dataset and metadata to support implementation of a scoring algorithm for the adolescent version of AQoL-6D | 3 |
ScorzAqol6Adult | A dataset and metadata to support implementation of a scoring algorithm for the adult version of AQoL-6D | |
ScorzEuroQol5 | A dataset and metadata to support implementation of an EQ-5D scoring algorithm | 4 |
ScorzProfile | A dataset to be scored, its associated metadata and details of the scoring instrument | |
SpecificConverter | Container for seed objects used for creating SpecificModels modules | 6 |
SpecificFixed | Modelling project dataset, input parameters and complete fixed models results | |
SpecificInitiator | Modelling project dataset, input parameters and empty results placeholder | |
SpecificMixed | Modelling project dataset, input parameters and complete mixed models results | |
SpecificModels | Modelling project dataset, input parameters and model comparison results | |
SpecificParameters | Input parameters that specify candidate models to be explored | |
SpecificPredictors | Modelling project dataset, input parameters and predictor comparison results | |
SpecificPrivate | Analysis outputs not intended for public dissemination | |
SpecificProject | Modelling project dataset, parameters and results | |
SpecificResults | Analysis results | |
SpecificShareable | Analysis outputs intended for public dissemination | |
SpecificSynopsis | Input, Output and Authorship Data For Generating Reports | |
TTUProject | Input And Output Data For Undertaking and Reporting Utility Mapping Studies | 5 |
TTUReports | Metadata to produce utility mapping study reports | 5 |
TTUSynopsis | Input, Output and Authorship Data For Generating Utility Mapping Study Reports | 5 |
YouthvarsDescriptives | Metadata about descriptive statistics to be generated | |
YouthvarsProfile | A dataset and its associated dictionary, descriptive statistics and metadata | 2 |
YouthvarsSeries | A longitudinal dataset and its associated dictionary, descriptive statistics and metadata | 2 |