Motivation
When considering whether to use a model module, it is useful to first see tutorials about appropriate use of that module.
Implementation
A table itemising individual model modules and sub-modules authored
with ready4 can be generated using
make_modules_tb. This function scrapes relevant data from
the websites of module libraries that have been developed within a
specified project’s GitHub organisation.
Use
In this example, we are going to examine modules from the readyforwhatsnext model. The
value supplied to the gh_repo_1L_chr argument specifies the
repository in which a dataset of readyforwhatsnext module libraries is
stored. Note, the following command may take a couple of minutes to
execute.
modules_tb <- make_modules_tb(gh_repo_1L_chr = "ready4-dev/ready4")## ⠙ 10 items, page 1 | 3msA slightly quicker method to achieve a similar result is to use the
get_modules_tb function. This function retrieves an
archived version (and therefore potentially less up to date) of the
modules summary table.
# Not run
# modules_tb <- get_modules_tb(gh_repo_1L_chr = "ready4-dev/ready4")The modules_tb object itemises both model modules
(which always use R’s “S4” class type) and sub-modules (“S3” class
type).
To display a HTML summary of just model modules, you can use the
print_modules function.
print_modules(modules_tb, what_1L_chr = "S4")| Class | Description | Examples |
|---|---|---|
| ReplicaAdder | An S4 class for assigning attributes to synthetic agents using contingency tables and marginal distributions | 2, 4 |
| ReplicaGrouper | Coordinates the generation of synthetic households from a synthetic population using one or more ReplicaStructure objects | 3 |
| ReplicaStructure | Represents a household structure used during synthetic household generation | 3 |
| 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 | 5 |
| 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 | 6 |
| ScorzProfile | A dataset to be scored, its associated metadata and details of the scoring instrument |
You can use the same function to display only model sub-modules.
print_modules(modules_tb, what_1L_chr = "S3")| Class | Description | Examples |
|---|---|---|
Related content
Details of how to search for themed collections of modules is described in another article.