Learn R Programming

ready4

Develop and Use Modular Health Economic Models

A template model module, tools to help find model modules derived from this template and a programming syntax to use these modules in health economic analyses. These elements are the foundation for a prototype software framework for developing living and transferable models and using those models in reproducible health economic analyses. The software framework is extended by other R libraries. For detailed documentation about the framework and how to use it visit https://www.ready4-dev.com/. For a background to the methodological issues that the framework is attempting to help solve, see Hamilton et al. (2024) https://doi.org/10.1007/s40273-024-01378-8.

To install a development version of this software, run the following commands in your R console:

utils::install.packages("devtools")

devtools::install_github("ready4-dev/ready4")

Copy Link

Version

Install

install.packages('ready4')

Monthly Downloads

189

Version

0.1.19

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Matthew Hamilton

Last Published

December 10th, 2025

Functions in ready4 (0.1.19)

bind_tables_from_loc_files

Bind tables from local files
get_functions_tb

Get functions tibble
get_dv_fls_urls

Get dataverse files urls
investigateSlot

Apply the investigate method to a model module slot
get_gh_repos

Get github repositories
get_gracefully

Get data from the internet with graceful failure
investigate

Investigate solutions to an inverse problem
depict

Depict (plot) features of model module data
depictSlot

Apply the depict method to a model module slot
enhance

Enhance a model module by adding new elements
get_libraries_tb

Get a table of ready4 libraries
enhanceSlot

Apply the enhance method to a model module slot
.data

Dot Data function
get_digits_from_text

Get digits from text
deprecated

Deprecated function
get_subroutine_repos

Get subroutine repositories
get_libraries_ls

Get libraries list
get_table_from_loc_file

Get table from local file
get_examples

Get examples
get_badge_urls

Get badge urls
exhibit

Exhibit features of model module data by printing them to the R console
get_generics

Get generics
get_excluded_repos

Get excluded repositories
make_datasets_tb

Make a tabular summary of ready4 model data collections
make_methods_tb

Make a tabular summary of methods associated with ready model modules
make_ds_releases_tbl

Make a tabular summary of release history of ready4 model data collections
make_modules_pkgs_chr

Make modules packages character vector
exhibitSlot

Apply the exhibit method to a model module slot
get_source_code_urls

Get source code urls
get_fl_extension

Get file extension
get_fl_id_from_dv_ls

Get file identity from dataverse list
ingestSlot

Apply the ingest method to a model module slot
ingest

Ingest data
make_fn_defaults_ls

Make function defaults list
get_methods_tb

Get a table of methods associated with ready4 model modules
make_framework_pkgs_chr

Make framework packages character vector
print_packages

Print a table of ready4 libraries
get_modules_tb

Get a table of ready4 model modules
renew

Renew (update) values
get_rds_from_dv

Get rds from dataverse
make_libraries_ls

Make libraries list
make_modules_tb

Make a tabular summary of ready4 model modules and sub-modules
make_programs_tbl

Make a tabular summary of programs using ready4 model modules
get_fl_nm_from_path

Get file name from path
get_badges_lup

Get badges lookup table
make_libraries_tb

Make libraries tibble
renewSlot

Renew (set) the values of data in a module slot
print_data

Print a table of ready4 model data collections
make_prompt

Make prompt
manufacture

Manufacture a new object
%>%

Pipe operator
prognosticate

Prognosticate (make predictions) by solving a forward problem
get_mthd_titles

Get method titles
ratifySlot

Apply the ratify method to a model module slot
ratify

Ratify that input or output data meet validity criteria
make_code_releases_tbl

Make a tabular summary of release history of ready4 code libraries and executables
get_r4_obj_slots

Get ready4 module object slots
transform_cls_type_ls

Transform class type list
print_dss

Print datasets
transform_chr_to_num

Transform character vector to numeric
print_dvs

Print dataverses
reckonSlot

Apply the reckon method to a model module slot
get_from_lup_obj

Get a value from a lookup table
make_additions_tb

Make additions tibble
write_fls_from_dv

Write files from dataverse
remove_lbls_from_df

Remove labels from dataframe
update_libraries_tb

Update libraries tibble
make_list_phrase

Make list phrase
update_libraries_ls

Update libraries list
metamorphoseSlot

Apply the metamorphose method to a model module slot
procure

Procure data from a model module
:=

Non standard evaluation assignment function
print_vignettes

Print vignettes
make_local_path_to_dv_data

Make local path to dataverse data
write_to_edit_workflow

Write to edit workflow
get_manual_urls

Get manual urls
rowbind_all_tbs_in_r4_obj

Rowbind all tibbles in ready4 module object
get_methods

Get the methods associated with a ready4 model module
manufactureSlot

Apply the manufacture method to a model module slot
make_files_tb

Make files tibble
make_dss_tb

Make datasets tibble
print_methods

Print a table of methods associated with ready4 model modules
metamorphose

Metamorphose a model module to a model module of a different (non-inheriting) class
prognosticateSlot

Apply the prognosticate method to a model module slot
write_new_credentials

Write new credentials
print_modules

Print a table of ready4 model modules
ready4-package

ready4: Develop and Use Modular Health Economic Models
rowbind_tbs_in_r4_obj

Rowbind tibbles in ready4 module object
write_ingested_dv_fl

Write ingested dataverse file
write_citation_cff

Write citation cff
write_conditional_tags

Write conditional tags
reckon

Reckon (calculate) a value
share

Share data via an online repository
procureSlot

Procure (get) data from a slot
write_to_delete_fls

Write to delete files
update_pt_fn_args_ls

Update prototype function arguments list
write_library_metadata

Write library metadata
write_new_dirs

Write new directories
write_dv_fl_to_loc

Write dataverse file to local
write_to_dv_from_tbl

Write to dataverse from table
update_tb_r3

Update tibble ready4 submodule
write_ws

Write ready4 software development local directories
write_to_dv_with_wait

Write to dataverse with wait
shareSlot

Apply the share method to a model module slot
write_to_copy_rmds

Write a local copy of RMD or Rmarkdown files
write_prj_outp_dirs

Write project output directories
write_to_delete_dirs

Write to delete directories
write_fls_to_dv

Write files to dataverse
write_tb_to_csv

Write tibble to comma separated variables file
write_all_tbs_in_tbs_r4_to_csvs

Write all tibbles in tibbles ready4 module to comma separated variables files
write_fls_to_repo

Write files to repository
write_examples

Write examples
write_from_tmp

Write from temporary
write_extra_pkgs_to_actions

Write extra packages to actions
write_blog_entries

Write blog entries
write_to_force_links_in

Write to force links in
write_to_publish_dv_ds

Write to publish dataverse dataset
write_to_render_post

Write ready4 model documentation website page from an RMD or Rmarkdown file
write_words

Write words
write_with_consent

Write with consent
write_to_trim_html

Write to trim html
write_obj_with_prompt

Write object with prompt
write_env_objs_to_dv

Write environment objects to dataverse
write_new_files

Write new files
add_rows_from_fn_args

Add rows from function arguments
author

Author and save files
Ready4Public-class

Ready4Public
Ready4Private-class

Ready4Private
Ready4Project-class

Ready4Project
Ready4Module-class

Ready4Module
authorFunctions

Author and document functions
authorReport

Author and save a report
authorClasses

Author and document classes
authorData

Author and document datasets
authorSlot

Apply the author method to a model module slot
add_vignette_links

Add vignette links
add_lups

Add lookup tables
add_scroll_box

Add scroll box
characterize

Characterize model module data by generating (tabular) descriptive statistics
add_references

Add references
get_cls_extensions

Get class extensions
get_datasets_tb

Get datasets tibble
characterizeSlot

Apply the characterize method to a model module slot