To combine model modules, it is first necessary for model developers and users to be able to find compatible module libraries. Manually keeping track of modules libraries authored by different teams can be an onerous undertaking. The ready4 package therefore includes tools to allow a modelling project’s maintainers to perform automated searches for model libraries and to output tabular summaries of these modules that are suitable for inclusion on documentation website pages.
A table summarising currently available module libraries authored
with the ready4
framework within a specified GitHub
organisation can be retrieved from an online dataset by using the
get_libraries_tb
and update_libraries_tb
functions.
libraries_tb <- get_libraries_tb(gh_repo_1L_chr = "ready4-dev/ready4") %>% update_libraries_tb(include_1L_chr = "modules")
Module libraries can be thematically grouped in model “sections”. In this youth mental health example, module libraries have been grouped in to three “sections”.
## [1] "People" "Places" "Programs"
We can use the print_packages
function to display the
module libraries currently available for each section.
Type | Package | Purpose | Documentation | Code | Examples |
---|---|---|---|---|---|
Describe and Validate Youth Mental Health Dataset Variables | Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) | Dev , Archive | 12, 13 | ||
Score Multi-Attribute Utility Instruments | Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) | Dev , Archive | 14, 15 | ||
Model Youth Choice Behaviours | Citation , Website , Citation | Dev , Archive | |||
Implement Transfer to Utility Mapping Algorithms | Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) | Dev , Archive | 16 | ||
Explore and Characterise Heterogeneity in Quality of Life Data | Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) | Dev , Archive | |||
Specify Models to Solve Inverse Problems | Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) | Dev , Archive | 17 | ||
Transform Youth Outcomes to Health Utility Predictions | Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) | Dev , Archive | 18 |
Type | Package | Purpose | Documentation | Code | Examples |
---|---|---|---|---|---|
Model Australian Spatial Data | Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) | Dev , Archive | |||
Model Spatial Features of Health Systems | Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) | Dev , Archive |
Type | Package | Purpose | Documentation | Code | Examples |
---|---|---|---|---|---|
Undertake Health Economic Budget Impact Analysis. | Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) | Dev , Archive | |||
Develop, Use and Share Unit Cost Datasets for Health Economic | Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) | Dev , Archive | 19, 20 |