authorClasses.ready4class_constructor() is an authorClasses method that authors and saves files necessary for creating and documenting classes. This method is implemented for the Class constructor table The function is called for its side effects and does not return a value.
Usage
authorClasses.ready4class_constructor(
x,
name_pfx_1L_chr,
output_dir_1L_chr,
file_exists_cdn_1L_chr = NULL,
prototype_lup = NULL,
dev_pkg_ns_1L_chr = ready4fun::get_dev_pkg_nm(),
nss_to_ignore_chr,
req_pkgs_chr = NA_character_,
class_in_cache_cdn_1L_chr = "stop",
abbreviations_lup,
fn_types_lup,
object_type_lup,
consent_1L_chr = NULL
)
# S4 method for ready4class_constructor
authorClasses(
x,
name_pfx_1L_chr,
output_dir_1L_chr,
file_exists_cdn_1L_chr = NULL,
prototype_lup = NULL,
dev_pkg_ns_1L_chr = ready4fun::get_dev_pkg_nm(),
nss_to_ignore_chr,
req_pkgs_chr = NA_character_,
class_in_cache_cdn_1L_chr = "stop",
abbreviations_lup,
fn_types_lup,
object_type_lup,
consent_1L_chr = NULL
)Arguments
- x
An instance of
ready4class_constructor, a Class constructor table- name_pfx_1L_chr
Name prefix (a character vector of length one)
- output_dir_1L_chr
Output directory (a character vector of length one)
- file_exists_cdn_1L_chr
File exists condition (a character vector of length one), Default: NULL
- prototype_lup
Prototype (a lookup table), Default: NULL
- dev_pkg_ns_1L_chr
Development package namespace (a character vector of length one), Default: ready4fun::get_dev_pkg_nm()
- nss_to_ignore_chr
Namespaces to ignore (a character vector)
- req_pkgs_chr
Require packages (a character vector), Default: 'NA'
- class_in_cache_cdn_1L_chr
Class in cache condition (a character vector of length one), Default: 'stop'
- abbreviations_lup
Abbreviations (a lookup table)
- fn_types_lup
Function types (a lookup table)
- object_type_lup
Object type (a lookup table)
- consent_1L_chr
Consent (a character vector of length one), Default: NULL