make_fn_dmt_tbl: Make function documentation table

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

make_fn_dmt_tbl() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make function documentation table. The function returns Function documentation table (a tibble).

Usage

make_fn_dmt_tbl(
  fns_path_chr,
  fns_dir_chr = make_undmtd_fns_dir_chr(),
  custom_dmt_ls = list(title_ls = NULL, desc_ls = NULL, details_ls = NULL,
    inc_for_main_user_lgl_ls = NULL, output_ls = NULL, example_ls = NULL, args_ls_ls =
    NULL),
  append_1L_lgl = T,
  fn_type_lup_tb = NULL,
  abbreviations_lup = NULL,
  object_type_lup = NULL,
  test_for_write_R_warning_fn = NULL
)

Arguments

fns_path_chr	Functions path (a character vector)
fns_dir_chr	Functions directory (a character vector), Default: make_undmtd_fns_dir_chr()
custom_dmt_ls	Custom documentation (a list), Default: list(title_ls = NULL, desc_ls = NULL, details_ls = NULL, inc_for_main_user_lgl_ls = NULL, output_ls = NULL, example_ls = NULL, args_ls_ls = NULL)
append_1L_lgl	Append (a logical vector of length one), Default: T
fn_type_lup_tb	Function type lookup table (a tibble), Default: NULL
abbreviations_lup	Abbreviations (a lookup table), Default: NULL
object_type_lup	Object type (a lookup table), Default: NULL
test_for_write_R_warning_fn	Test for write warning (a function), Default: NULL

Value

Function documentation table (a tibble)

readyforwhatsnext/ready4fun documentation built on Nov. 22, 2020, 9:28 p.m.