set_struct_obj: define a new struct object

In computational-metabolomics/struct: Statistics in R Using Class-based Templates

define a new struct object

Description

a helper function to create new struct objects

Usage

set_struct_obj(
  class_name,
  struct_obj,
  params = character(0),
  outputs = character(0),
  private = character(0),
  prototype = list()
)

Arguments

class_name	the name of the new class to create
struct_obj	the struct obj to inherit e.g. 'model', 'metric' etc
params	a named character vector of input parameters where each element specifies the type of value that will be in the slot e.g. c(example = 'character')
outputs	a named character vector of outputs where each element specifies the type of value that will be in the slot e.g. c(example = 'character')
private	a named character vector of private slots where each element specifies the type of value that will be in the slot e.g. c(example = 'character'). These are intended for internal use by the object and generally not available to the user.
prototype	a named list with initial values for slots.

Value

a new class definition. to create a new object from this class use X = new_class_name()

computational-metabolomics/struct documentation built on March 27, 2024, 4:26 p.m.