make_ret_obj_desc: Make return object description

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

Make return object description

Description

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

Usage

make_ret_obj_desc(
  fn,
  abbreviations_lup,
  class_name_1L_chr = "",
  starts_sentence_1L_lgl = T
)

Arguments

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

Value

Return object description (a character vector of length one)

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