Skip to contents

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/")
## ⠙ 10 items, page 1 | 3ms

In this example, module libraries have been grouped in to the following thematic model “sections”.

libraries_tb$Section %>% unique()
## [1] "People"   "Programs"

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, sections_chr = "People")
Type Package Purpose Documentation Code Examples
Score Multi-Attribute Utility Instruments Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) Dev , Archive 13, 14
Describe and Validate Youth Mental Health Economic Datasets Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) Dev , Archive 15, 16
Create Synthetic Populations For Use In Mental Health Economic Models Citation, Website Dev , Archive 17, 18, 19, 20
print_packages(libraries_tb, sections_chr = "Programs")
Type Package Purpose Documentation Code Examples
Implement Simple Microsimulation to Economically Evaluate Mental Health Services Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) Dev , Archive
Develop, Test and Apply Time Series Models for Mental Health Economic Analyses Citation , Website , Manual - Short (PDF) , Manual - Full (PDF) Dev , Archive

Details of how to search for details on individual modules is described in another article.