write_scripts_to_mk_r3_cls: Write scripts to make readyforwhatsnext S3 class

In readyforwhatsnext/ready4class: Readyforwhatsnext Tools For Creating And Extending Classes.

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 readyforwhatsnext s3 class. The function is called for its side effects and does not return a value. WARNING: This function writes R scripts to your local environment. Make sure to only use if you want this behaviour

Usage

write_scripts_to_mk_r3_cls(
  name_stub_1L_chr,
  name_pfx_1L_chr = "ready4_",
  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,
  nss_to_ignore_chr = NA_character_,
  file_exists_cdn_1L_chr = "skip",
  abbreviations_lup = 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), Default: 'ready4_'
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	Min max values (a double vector), Default: NULL
start_end_vals_dbl	Start end values (a double vector), Default: NULL
prototype_lup	Prototype (a lookup table)
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), Default: NULL

readyforwhatsnext/ready4class documentation built on Nov. 14, 2020, 1:29 a.m.