make_fn_desc: Make function description

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

make_fn_desc() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make function description. The function returns Function description (a character vector).

Usage

make_fn_desc(
  fns_chr,
  title_chr,
  output_chr,
  fn_type_lup_tb = NULL,
  abbreviations_lup = NULL,
  test_for_write_R_warning_fn = NULL,
  is_generic_lgl = F
)

Arguments

fns_chr	Functions (a character vector)
title_chr	Title (a character vector)
output_chr	Output (a character vector)
fn_type_lup_tb	Function type lookup table (a tibble), Default: NULL
abbreviations_lup	Abbreviations (a lookup table), Default: NULL
test_for_write_R_warning_fn	Test for write warning (a function), Default: NULL
is_generic_lgl	Is generic (a logical vector), Default: F

Value

Function description (a character vector)

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