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

185

Version

0.1.18

License

GPL-3

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/ready4-dev/ready4

Homepage

https://ready4-dev.github.io/ready4/

Maintainer

Matthew Hamilton

Last Published

September 30th, 2024

Functions in ready4 (0.1.18)

Ready4Module-class

add_rows_from_fn_args

Add rows from function arguments

bind_tables_from_loc_files

Bind tables from local files

Author and save files

Characterize model module data by generating (tabular) descriptive statistics

add_vignette_links

Add vignette links

Ready4Public-class

Ready4Private-class

Author and save a report

characterizeSlot

Apply the characterize method to a model module slot

Author and document classes

Get badges lookup table

Depict (plot) features of model module data

get_cls_extensions

Get class extensions

get_fl_id_from_dv_ls

Get file identity from dataverse list

get_fl_nm_from_path

Get file name from path

Author and document datasets

Apply the author method to a model module slot

Add lookup tables

Get a table of ready4 model modules

Apply the enhance method to a model module slot

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

Get data from the internet with graceful failure

get_libraries_ls

Get libraries list

investigateSlot

Apply the investigate method to a model module slot

get_datasets_tb

Get datasets tibble

authorFunctions

Author and document functions

get_mthd_titles

Get method titles

Apply the exhibit method to a model module slot

Apply the depict method to a model module slot

make_additions_tb

Make additions tibble

Deprecated function

get_from_lup_obj

Get a value from a lookup table

Dot Data function

Make files tibble

make_fn_defaults_ls

Make function defaults list

get_digits_from_text

Get digits from text

Enhance a model module by adding new elements

get_excluded_repos

Get excluded repositories

Manufacture a new object

get_functions_tb

Get functions tibble

Apply the ingest method to a model module slot

manufactureSlot

Apply the manufacture method to a model module slot

Investigate solutions to an inverse problem

get_fl_extension

Get file extension

Print a table of ready4 model modules

get_r4_obj_slots

Get ready4 module object slots

make_libraries_tb

Make libraries tibble

get_rds_from_dv

Get rds from dataverse

get_table_from_loc_file

Get table from local file

make_list_phrase

Make list phrase

print_vignettes

Print vignettes

Get github repositories

make_modules_pkgs_chr

Make modules packages character vector

make_modules_tb

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

Get the methods associated with a ready4 model module

Print a table of ready4 libraries

make_ds_releases_tbl

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

Procure data from a model module

remove_lbls_from_df

Remove labels from dataframe

Reckon (calculate) a value

Get a table of methods associated with ready4 model modules

Make datasets tibble

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

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

rowbind_all_tbs_in_r4_obj

Rowbind all tibbles in ready4 module object

metamorphoseSlot

Apply the metamorphose method to a model module slot

get_dv_fls_urls

Get dataverse files urls

Renew (update) values

make_code_releases_tbl

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

Apply the reckon method to a model module slot

get_libraries_tb

Get a table of ready4 libraries

get_manual_urls

Get manual urls

make_datasets_tb

Make a tabular summary of ready4 model data collections

get_source_code_urls

Get source code urls

get_subroutine_repos

Get subroutine repositories

make_local_path_to_dv_data

Make local path to dataverse data

Apply the share method to a model module slot

make_methods_tb

Make a tabular summary of methods associated with ready model modules

transform_chr_to_num

Transform character vector to numeric

make_framework_pkgs_chr

Make framework packages character vector

make_programs_tbl

Make a tabular summary of programs using ready4 model modules

Update tibble ready4 submodule

Print dataverses

write_all_tbs_in_tbs_r4_to_csvs

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

write_extra_pkgs_to_actions

Write extra packages to actions

Print a table of methods associated with ready4 model modules

Print a table of ready4 model data collections

write_fls_from_dv

Write files from dataverse

write_library_metadata

Write library metadata

Apply the ratify method to a model module slot

ready4: Develop and Use Modular Health Economic Models

write_new_credentials

Write new credentials

write_fls_to_dv

Write files to dataverse

write_to_publish_dv_ds

Write to publish dataverse dataset

write_fls_to_repo

Write files to repository

write_to_render_post

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

prognosticateSlot

Apply the prognosticate method to a model module slot

Ratify that input or output data meet validity criteria

rowbind_tbs_in_r4_obj

Rowbind tibbles in ready4 module object

write_obj_with_prompt

Write object with prompt

transform_cls_type_ls

Transform class type list

update_libraries_tb

Update libraries tibble

make_libraries_ls

Make libraries list

update_pt_fn_args_ls

Update prototype function arguments list

update_libraries_ls

Update libraries list

Share data via an online repository

write_blog_entries

Write blog entries

Non standard evaluation assignment function

write_conditional_tags

Write conditional tags

write_citation_cff

Write citation cff

write_env_objs_to_dv

Write environment objects to dataverse

write_dv_fl_to_loc

Write dataverse file to local

write_to_edit_workflow

Write to edit workflow

write_prj_outp_dirs

Write project output directories

write_to_force_links_in

Write to force links in

Write from temporary

write_to_trim_html

Write to trim html

write_ingested_dv_fl

Write ingested dataverse file

write_to_delete_dirs

Write to delete directories

write_to_delete_fls

Write to delete files

write_with_consent

Write with consent

Procure (get) data from a slot

Prognosticate (make predictions) by solving a forward problem

write_tb_to_csv

Write tibble to comma separated variables file

write_to_copy_rmds

Write a local copy of RMD or Rmarkdown files

write_to_dv_from_tbl

Write to dataverse from table

write_to_dv_with_wait

Write to dataverse with wait

Write new directories

write_new_files

Write new files

Write ready4 software development local directories