ready4use_distributions: ready4 submodule class for list object that summarises the...

In ready4-dev/ready4use: Ingest, Label, Visualise and Share Health Economic Model Datasets

ready4 submodule class for list object that summarises the parameters of each distribution

Description

Create a new valid instance of the ready4 submodule class for list object that summarises the parameters of each distribution

Usage

ready4use_distributions(x = make_pt_ready4use_distributions())

make_pt_ready4use_distributions(
  distribution_chr = character(0),
  dstr_param_1_dbl = numeric(0),
  dstr_param_2_dbl = numeric(0),
  dstr_param_3_dbl = numeric(0),
  dstr_param_4_dbl = numeric(0),
  transformation_chr = character(0)
)

is_ready4use_distributions(x)

Arguments

x	An object of any type
distribution_chr	Distribution (a character vector), Default: character(0)
dstr_param_1_dbl	Distribution parameter 1 (a double vector), Default: numeric(0)
dstr_param_2_dbl	Distribution parameter 2 (a double vector), Default: numeric(0)
dstr_param_3_dbl	Distribution parameter 3 (a double vector), Default: numeric(0)
dstr_param_4_dbl	Distribution parameter 4 (a double vector), Default: numeric(0)
transformation_chr	Transformation (a character vector), Default: character(0)

Details

List object that summarises the parameters of each distribution

Value

A validated instance of the ready4 submodule class for list object that summarises the parameters of each distribution

A prototype for ready4 submodule class for list object that summarises the parameters of each distribution

A logical value, TRUE if a valid instance of the ready4 submodule class for list object that summarises the parameters of each distribution

ready4-dev/ready4use documentation built on June 1, 2025, 2:06 p.m.