make_new_fn_dmt: Make new function documentation

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

Make new function documentation

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,
  class_name_1L_chr = "",
  fn = NULL,
  abbreviations_lup = NULL,
  dv_ds_nm_1L_chr = "ready4-dev/ready4",
  dv_url_pfx_1L_chr = deprecated(),
  key_1L_chr = deprecated(),
  object_type_lup = NULL,
  server_1L_chr = deprecated()
)

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 detail (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
class_name_1L_chr	Class name (a character vector of length one), Default: ”
fn	Function (a function), Default: NULL
abbreviations_lup	Abbreviations (a lookup table), Default: NULL
dv_ds_nm_1L_chr	Dataverse dataset name (a character vector of length one), Default: 'ready4-dev/ready4'
dv_url_pfx_1L_chr	Dataverse url prefix (a character vector of length one), Default: deprecated()
key_1L_chr	Key (a character vector of length one), Default: deprecated()
object_type_lup	Object type (a lookup table), Default: NULL
server_1L_chr	Server (a character vector of length one), Default: deprecated()

Value

New function documentation (a list of character vectors)

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