struct_class-class {struct} | R Documentation

## `struct_class` object definition

### Description

Defines the struct class base template. This class is inherited by other objects and not intended for direct use. It defines slots and methods common to all struct objects.

### Value

Returns a struct object

### Public slots

Public slots can be accessed using shorthand $ notation and are intended for users building workflows.

`name`

  `character()` A short descriptive name of the struct object

`description`

  `character()` A longer description of the struct object and what it does

`type`

  `character()` A keyword that describes the type of struct object

`libraries`

  `character()` A (read only) list of R packages used by this struct object

`citations`

  `list of bibentry` A (read only) list of citations relevant to this struct object, in Bibtex format.

### Private slots

Private slots are not readily accessible to users and are intended for developers creating their own struct objects. Any slot not listed within '.params' or '.outputs' is considered a private slot.

`.params`

  `character()` A list of additional slot names that can be get/set by the user for a specific struct object. These are used as input parameters for different methods.

`.outputs`

  `character()` a list of additional slot names that can be get by the user. These are used to store the results of a method.

### Examples

    S = struct_class(name = 'Example',description = 'An example object')

[Package struct version 1.2.0 Index]