make_arg_desc: Make argument description

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

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

Usage

make_arg_desc(fn_args_chr, object_type_lup = NULL, abbreviations_lup = NULL)

Arguments

fn_args_chr	Function arguments (a character vector)
object_type_lup	Object type (a lookup table), Default: NULL
abbreviations_lup	Abbreviations (a lookup table), Default: NULL

Value

Argument description (a character vector)

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