make_new_fn_dmt: Make new function documentation

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

make_new_fn_dmt() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make new function documentation. The function returns New function documentation (a list of character vectors).

Usage

make_new_fn_dmt(
  fn_type_1L_chr,
  fn_name_1L_chr,
  fn_desc_1L_chr = NA_character_,
  fn_det_1L_chr = NA_character_,
  fn_out_type_1L_chr = NA_character_,
  args_ls = NULL,
  fn = NULL,
  abbreviations_lup = NULL,
  object_type_lup = NULL
)

Arguments

fn_type_1L_chr	Function type (a character vector of length one)
fn_name_1L_chr	Function name (a character vector of length one)
fn_desc_1L_chr	Function description (a character vector of length one), Default: 'NA'
fn_det_1L_chr	Function det (a character vector of length one), Default: 'NA'
fn_out_type_1L_chr	Function out type (a character vector of length one), Default: 'NA'
args_ls	Arguments (a list), Default: NULL
fn	Function (a function), Default: NULL
abbreviations_lup	Abbreviations (a lookup table), Default: NULL
object_type_lup	Object type (a lookup table), Default: NULL

Value

New function documentation (a list of character vectors)

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