make_ret_obj_desc: Make ret object description

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

make_ret_obj_desc() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make ret object description. The function returns Ret object description (a character vector of length one).

Usage

make_ret_obj_desc(fn, abbreviations_lup, starts_sentence_1L_lgl = T)

Arguments

fn	Function (a function)
abbreviations_lup	Abbreviations (a lookup table)
starts_sentence_1L_lgl	Starts sentence (a logical vector of length one), Default: T

Value

Ret object description (a character vector of length one)

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