make_std_fn_dmt_spine: Make standard function documentation spine

Description Usage Arguments Value

Description

make_std_fn_dmt_spine() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make standard function documentation spine. The function returns Standard function documentation spine (a list of character vectors).

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
make_std_fn_dmt_spine(
  fn_name_1L_chr,
  fn_type_1L_chr,
  fn_title_1L_chr,
  fn,
  details_1L_chr = NA_character_,
  example_1L_lgl = F,
  export_1L_lgl = T,
  class_name_1L_chr = "",
  exclude_if_match_chr
)

Arguments

fn_name_1L_chr

Function name (a character vector of length one)

fn_type_1L_chr

Function type (a character vector of length one)

fn_title_1L_chr

Function title (a character vector of length one)

fn

Function (a function)

details_1L_chr

Details (a character vector of length one), Default: 'NA'

example_1L_lgl

Example (a logical vector of length one), Default: F

export_1L_lgl

Export (a logical vector of length one), Default: T

class_name_1L_chr

Class name (a character vector of length one), Default: ”

exclude_if_match_chr

Exclude if match (a character vector)

Value

Standard function documentation spine (a list of character vectors)


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