authorClasses-methods: Author and document classes

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

Author and document classes

Description

authorClasses.ready4fun_manifest() is an authorClasses method that authors and saves files necessary for creating and documenting classes. This method is implemented for the ready4 submodule class for encapsulating the metadata required for package set-up. The function is called for its side effects and does not return a value.

Usage

authorClasses.ready4fun_manifest(
  x,
  key_1L_chr = NULL,
  self_serve_1L_lgl = F,
  self_serve_fn_ls = NULL
)

## S4 method for signature 'ready4fun_manifest'
authorClasses(
  x,
  key_1L_chr = NULL,
  self_serve_1L_lgl = F,
  self_serve_fn_ls = NULL
)

Arguments

x	An instance of ready4fun_manifest, a ready4 submodule class for encapsulating the metadata required for package set-up.
key_1L_chr	Key (a character vector of length one), Default: NULL
self_serve_1L_lgl	Self serve (a logical vector of length one), Default: F
self_serve_fn_ls	Self serve (a list of functions), Default: NULL

Value

No return value, called for side effects.

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