ready4class_constructor: Class constructor table

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

Class constructor table

Description

Create a new valid instance of the Class constructor table

Usage

ready4class_constructor(x = make_pt_ready4class_constructor())

make_pt_ready4class_constructor(
  make_s3_lgl = logical(0),
  name_stub_chr = character(0),
  pt_ls = list(),
  pt_chkr_pfx_ls = list(),
  pt_ns_ls = list(),
  vals_ls = list(),
  allowed_vals_ls = list(),
  min_max_vals_ls = list(),
  start_end_vals_ls = list(),
  class_desc_chr = character(0),
  parent_class_chr = character(0),
  slots_ls = list(),
  meaningful_nms_ls = list(),
  inc_clss_ls = list(),
  asserts_ls = list()
)

is_ready4class_constructor(x)

Arguments

x	An object of any type
make_s3_lgl	Make S3 (a logical vector), Default: logical(0)
name_stub_chr	Name stub (a character vector), Default: character(0)
pt_ls	Prototype (a list), Default: list()
pt_chkr_pfx_ls	Prototype checker prefix (a list), Default: list()
pt_ns_ls	Prototype namespace (a list), Default: list()
vals_ls	Values (a list), Default: list()
allowed_vals_ls	Allowed values (a list), Default: list()
min_max_vals_ls	Minimum maximum values (a list), Default: list()
start_end_vals_ls	Start end values (a list), Default: list()
class_desc_chr	Class description (a character vector), Default: character(0)
parent_class_chr	Parent class (a character vector), Default: character(0)
slots_ls	Slots (a list), Default: list()
meaningful_nms_ls	Meaningful names (a list), Default: list()
inc_clss_ls	Include classes (a list), Default: list()
asserts_ls	Asserts (a list), Default: list()

Details

Class constructor table

Value

A validated instance of the Class constructor table

A prototype for Class constructor table

A logical value, TRUE if a valid instance of the Class constructor table

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