make_fn_desc: Make function description

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

Make function description

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,
  fns_env_ls,
  fn_types_lup = NULL,
  abbreviations_lup,
  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)
fns_env_ls	Functions (a list of environments)
fn_types_lup	Function types (a lookup table), Default: NULL
abbreviations_lup	Abbreviations (a lookup table)
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)

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