write_scripts_to_mk_r4_cls: Write scripts to make ready4 module class

In ready4-dev/ready4class: Author and Document Classes that Make Health Economic Models Modular

Write scripts to make ready4 module class

Description

write_scripts_to_mk_r4_cls() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write scripts to make ready4 module class. The function is called for its side effects and does not return a value.

Usage

write_scripts_to_mk_r4_cls(
  name_stub_1L_chr,
  name_pfx_1L_chr,
  slots_chr,
  type_chr,
  prototype_lup,
  abbreviations_lup = NULL,
  accessors_1L_lgl = F,
  allowed_vals_ls = NULL,
  asserts_ls = NULL,
  class_desc_1L_chr = "",
  class_in_cache_cdn_1L_chr = "stop",
  clss_to_inc_chr = NULL,
  consent_1L_chr = NULL,
  meaningful_nms_ls = NULL,
  object_type_lup,
  output_dir_1L_chr = "data-raw",
  outp_sub_dir_1L_chr = NULL,
  names_must_match_ls = NULL,
  nss_to_ignore_chr = NA_character_,
  parent_cls_nm_1L_chr = NULL,
  req_pkgs_chr = NA_character_,
  slots_of_dif_lnts_chr = NULL,
  vals_ls = NULL,
  fn_types_lup = NULL,
  helper_1L_lgl = F,
  print_set_cls_1L_lgl = TRUE,
  print_gtrs_strs_1L_lgl = TRUE,
  print_validator_1L_lgl = TRUE,
  print_meaningful_nms_ls_1L_lgl = TRUE
)

Arguments

name_stub_1L_chr	Name stub (a character vector of length one)
name_pfx_1L_chr	Name prefix (a character vector of length one)
slots_chr	Slots (a character vector)
type_chr	Type (a character vector)
prototype_lup	Prototype (a lookup table)
abbreviations_lup	Abbreviations (a lookup table), Default: NULL
accessors_1L_lgl	Accessors (a logical vector of length one), Default: F
allowed_vals_ls	Allowed values (a list), Default: NULL
asserts_ls	Asserts (a list), Default: NULL
class_desc_1L_chr	Class description (a character vector of length one), Default: ”
class_in_cache_cdn_1L_chr	Class in cache condition (a character vector of length one), Default: 'stop'
clss_to_inc_chr	Classes to include (a character vector), Default: NULL
consent_1L_chr	Consent (a character vector of length one), Default: NULL
meaningful_nms_ls	Meaningful names (a list), Default: NULL
object_type_lup	Object type (a lookup table)
output_dir_1L_chr	Output directory (a character vector of length one), Default: 'data-raw'
outp_sub_dir_1L_chr	Output sub directory (a character vector of length one), Default: NULL
names_must_match_ls	Names must match (a list), Default: NULL
nss_to_ignore_chr	Namespaces to ignore (a character vector), Default: 'NA'
parent_cls_nm_1L_chr	Parent class name (a character vector of length one), Default: NULL
req_pkgs_chr	Require packages (a character vector), Default: 'NA'
slots_of_dif_lnts_chr	Slots of different lengths (a character vector), Default: NULL
vals_ls	Values (a list), Default: NULL
fn_types_lup	Function types (a lookup table), Default: NULL
helper_1L_lgl	Helper (a logical vector of length one), Default: F
print_set_cls_1L_lgl	Print set class (a logical vector of length one), Default: TRUE
print_gtrs_strs_1L_lgl	Print getters setters (a logical vector of length one), Default: TRUE
print_validator_1L_lgl	Print validator (a logical vector of length one), Default: TRUE
print_meaningful_nms_ls_1L_lgl	Print meaningful names list (a logical vector of length one), Default: TRUE

Value

No return value, called for side effects.

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