enum_stato: enum_stato class

Description Usage Arguments Details Value See Also Examples

View source: R/enum_stato_class.R

Description

A base class in the struct package. Should not be called directly.

Usage

1
2
3
4
5
6
7
8
9
enum_stato(
  name,
  description = character(0),
  type = "character",
  value = character(0),
  max_length = 1,
  allowed,
  stato_id
)

Arguments

name

the name of the object

description

a description of the object

type

the type of the struct object

value

The value of the parameter/outputs

max_length

Maximum length of value vector (default 1)

allowed

A list of allowed values

stato_id

The STATO ID for the entity

Details

Extends the enum class to include stato functionality.

Value

an enum_stato object

See Also

Refer to enum and stato for further info.

Examples

1
2
3
4
5
6
7
E = enum_stato(
    name='example',
    allowed=list('choice_1','choice_2'),
    value='choice_1',
    type='character',
    stato_id='XYZ000001'
)

computational-metabolomics/struct documentation built on Nov. 17, 2021, 8:57 a.m.