write_scripts_to_mk_r3_cls: Write scripts to make ready4 submodule class

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

Write scripts to make ready4 submodule class

Description

write_scripts_to_mk_r3_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 submodule class. The function is called for its side effects and does not return a value.

Usage

write_scripts_to_mk_r3_cls(
  name_stub_1L_chr,
  name_pfx_1L_chr,
  output_dir_1L_chr = "data-raw",
  class_desc_1L_chr = "",
  parent_cls_nm_1L_chr = NULL,
  type_1L_chr,
  pt_ns_1L_chr = "",
  pt_chkr_pfx_1L_chr = "is.",
  vals_ls = NULL,
  ordered_1L_lgl = FALSE,
  allowed_vals_ls = NULL,
  min_max_vals_dbl = NULL,
  start_end_vals_dbl = NULL,
  prototype_lup,
  dev_pkg_ns_1L_chr = ready4fun::get_dev_pkg_nm(),
  nss_to_ignore_chr = NA_character_,
  file_exists_cdn_1L_chr = "skip",
  abbreviations_lup,
  asserts_ls = NULL,
  fn_types_lup = NULL,
  object_type_lup,
  consent_1L_chr = NULL
)

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)
output_dir_1L_chr	Output directory (a character vector of length one), Default: 'data-raw'
class_desc_1L_chr	Class description (a character vector of length one), Default: ”
parent_cls_nm_1L_chr	Parent class name (a character vector of length one), Default: NULL
type_1L_chr	Type (a character vector of length one)
pt_ns_1L_chr	Prototype namespace (a character vector of length one), Default: ”
pt_chkr_pfx_1L_chr	Prototype checker prefix (a character vector of length one), Default: 'is.'
vals_ls	Values (a list), Default: NULL
ordered_1L_lgl	Ordered (a logical vector of length one), Default: FALSE
allowed_vals_ls	Allowed values (a list), Default: NULL
min_max_vals_dbl	Minimum maximum values (a double vector), Default: NULL
start_end_vals_dbl	Start end values (a double vector), Default: NULL
prototype_lup	Prototype (a lookup table)
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), Default: 'NA'
file_exists_cdn_1L_chr	File exists condition (a character vector of length one), Default: 'skip'
abbreviations_lup	Abbreviations (a lookup table)
asserts_ls	Asserts (a list), Default: NULL
fn_types_lup	Function types (a lookup table), Default: NULL
object_type_lup	Object type (a lookup table)
consent_1L_chr	Consent (a character vector of length one), Default: NULL

Value

No return value, called for side effects.

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