make_dmt_for_all_fns: Make documentation for all functions

In ready4-dev/ready4fun: Author and Document Functions that Implement Transferable Health Economic Model Algorithms

Make documentation for all functions

Description

make_dmt_for_all_fns() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make documentation for all functions. The function returns All functions documentation (a tibble).

Usage

make_dmt_for_all_fns(
  abbreviations_lup,
  fn_types_lup,
  object_type_lup,
  append_1L_lgl = T,
  custom_dmt_ls = make_custom_dmt_ls(),
  fns_env_ls = NULL,
  inc_all_mthds_1L_lgl = T,
  paths_ls = make_fn_nms(),
  undocumented_fns_dir_chr = make_undmtd_fns_dir_chr(drop_empty_1L_lgl = T)
)

Arguments

abbreviations_lup	Abbreviations (a lookup table)
fn_types_lup	Function types (a lookup table)
object_type_lup	Object type (a lookup table)
append_1L_lgl	Append (a logical vector of length one), Default: T
custom_dmt_ls	Custom documentation (a list), Default: make_custom_dmt_ls()
fns_env_ls	Functions (a list of environments), Default: NULL
inc_all_mthds_1L_lgl	Include all methods (a logical vector of length one), Default: T
paths_ls	Paths (a list), Default: make_fn_nms()
undocumented_fns_dir_chr	Undocumented functions directory (a character vector), Default: make_undmtd_fns_dir_chr(drop_empty_1L_lgl = T)

Value

All functions documentation (a tibble)

ready4-dev/ready4fun documentation built on April 22, 2024, 8:33 a.m.