make_lines_for_fn_dmt: Make lines for function documentation

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

make_lines_for_fn_dmt() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make lines for function documentation. The function is called for its side effects and does not return a value.

Usage

make_lines_for_fn_dmt(
  fn_name_1L_chr,
  fn_type_1L_chr,
  fn = NULL,
  fn_desc_1L_chr = NA_character_,
  fn_out_type_1L_chr = NA_character_,
  fn_title_1L_chr = NA_character_,
  example_1L_lgl = F,
  export_1L_lgl = T,
  class_name_1L_chr = "",
  details_1L_chr = "DETAILS",
  args_ls = NULL,
  import_chr = NA_character_,
  doc_in_class_1L_lgl = F,
  abbreviations_lup = NULL,
  object_type_lup = NULL
)

Arguments

fn_name_1L_chr	Function name (a character vector of length one)
fn_type_1L_chr	Function type (a character vector of length one)
fn	Function (a function), Default: NULL
fn_desc_1L_chr	Function description (a character vector of length one), Default: 'NA'
fn_out_type_1L_chr	Function out type (a character vector of length one), Default: 'NA'
fn_title_1L_chr	Function title (a character vector of length one), Default: 'NA'
example_1L_lgl	Example (a logical vector of length one), Default: F
export_1L_lgl	Export (a logical vector of length one), Default: T
class_name_1L_chr	Class name (a character vector of length one), Default: ”
details_1L_chr	Details (a character vector of length one), Default: 'DETAILS'
args_ls	Arguments (a list), Default: NULL
import_chr	Import (a character vector), Default: 'NA'
doc_in_class_1L_lgl	Document in class (a logical vector of length one), Default: F
abbreviations_lup	Abbreviations (a lookup table), Default: NULL
object_type_lup	Object type (a lookup table), Default: NULL

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