Find examples of how model modules are used
Categories:
This below section renders a vignette article from the ready4 library. You can use the following links to:
- view the vignette on the library website (adds useful hyperlinks to code blocks)
- view the source file from that article, and;
- edit its contents (requires a GitHub account).
Motivation
To use and combine health economic model modules it is first useful to find modules that have been developed using a common framework that promotes inter-operability.
Implementation
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.
Use
In the below example we will search for modules from the readyforwhatsnext model. The source code for these modules all reside in the ready4-dev GitHub repository. The value supplied to the gh_repo_1L_chr argument specifies the repository in which a dataset of readyforwhatsnext module libraries is stored.
libraries_tb <- get_libraries_tb(gh_repo_1L_chr = "ready4-dev/ready4") %>% update_libraries_tb(include_1L_chr = "modules", url_stub_1L_chr = "https://ready4-dev.github.io/")In this example, module libraries have been grouped in to the following thematic model “sections”.
We can use the print_packages function to display a HTML summary of the module libraries currently available for each section. The resulting table summarises the types of module library (e.g. those for description, developing models or predicting with models), the name and purpose of those libraries, the locations from which development and archived library code can be downloaded and details of supporting documentation for each library (e.g. website, manuals and examples).
print_packages(libraries_tb %>% dplyr::filter(Section == "People"))
| 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 |
print_packages(libraries_tb %>% dplyr::filter(Section == "Places"))
| 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 |
print_packages(libraries_tb %>% dplyr::filter(Section == "Programs"))
| 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 |
Related content
Details of how to search for details on individual modules is described in another article.