# Statistics in R Using Class-based Templates

## Documentation for package ‘struct’ version 1.2.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A C D E I L M N O P R S T V misc

## -- A --

as.code | Convert to code
as.code-method | Convert to code
as.DatasetExperiment | Convert a SummarizedExperiment to DatasetExperiment
as.DatasetExperiment-method | Convert a SummarizedExperiment to DatasetExperiment
as.SummarizedExperiment | Convert a DatasetExperiment to a SummarizedExperiment
as.SummarizedExperiment-method | Convert a DatasetExperiment to SummarizedExperiment
as_data_frame | convert to data.frame

## -- C --

calculate | Calculate metric
calculate-method | Calculate metric
calculate-method | Example metric
chart | Constructor for struct chart objects
chart_names | chart names
chart_names-method | chart names
chart_plot | chart_plot
chart_plot-method | example chart object
chart_plot-method | chart_plot
citations | Citations for an object
citations-method | Citations for an object

## -- D --

DatasetExperiment | DatasetExperiment class

## -- E --

entity | get the max value vector length for an entity
entity_stato | entity_stato class
enum | Enum objects
enum_stato | enum_stato class
evaluate | Run iterator
evaluate-method | Run iterator
example_chart | example chart object
example_iterator | Example iterator
example_iterator-class | Example iterator
example_model | Example model
export_xlsx | write a dataset object to file
export_xlsx-method | write a dataset object to file

## -- I --

iris_DatasetExperiment | Fisher's Iris data
is_output | Verify output
is_output-method | Verify output
is_param | Verify parameter
is_param-method | Verify parameter
iterator | Run iterator

## -- L --

length-method | model_seq class
libraries | Libraries for an object
libraries-method | Libraries for an object

## -- M --

max_length | get the max value vector length for an entity
max_length-method | get the max value vector length for an entity
max_length<- | Calculate metric
max_length<--method | get the max value vector length for an entity
metric | Calculate metric
model | model class
models | Get/set models of a model_seq
models-method | Run iterator
models-method | model_seq class
models<- | Get/set models of a model_seq
models<--method | Run iterator
models<--method | model_seq class
model_apply | Apply a model
model_apply-method | model class
model_apply-method | model_seq class
model_predict | Model prediction
model_predict-method | Example model
model_predict-method | model class
model_predict-method | model_seq class
model_reverse | Reverse preprocessing
model_reverse-method | model class
model_reverse-method | preprocessing class
model_seq | model_seq class
model_train | Train a model
model_train-method | Example model
model_train-method | model class
model_train-method | model_seq class

## -- N --

new_struct | Generate a 'struct' object from a Class

## -- O --

optimiser | optimiser class
output_ids | Output identifiers
output_ids-method | Output identifiers
output_list | output list
output_list-method | output list
output_list<- | output list
output_list<--method | output list
output_name | output name
output_name-method | output name
output_obj | Output objects
output_obj-method | Output objects
output_obj<- | Output objects
output_obj<--method | Output objects
output_value | output values
output_value-method | output values
output_value<- | output values
output_value<--method | output values

## -- P --

param_ids | Parameter identifiers
param_ids-method | Parameter identifiers
param_list | Parameter list
param_list-method | Parameter list
param_list<- | Parameter list
param_list<--method | Parameter list
param_name | Parameter name
param_name-method | Parameter name
param_obj | Parameter objects
param_obj-method | Parameter objects
param_obj<- | Parameter objects
param_obj<--method | Parameter objects
param_value | Parameter values
param_value-method | Parameter values
param_value<- | Parameter values
param_value<--method | Parameter values
predicted | Prediction output
predicted-method | model class
predicted-method | model_seq class
predicted_name | Predicted output name
predicted_name-method | model class
predicted_name<- | Predicted output name
predicted_name<--method | model class
preprocess | preprocessing class

## -- R --

resampler | resampler class
result | Iterator result
result-method | Run iterator
result_name | get/set output name as prediction output for a model
result_name-method | Run iterator
result_name<- | get/set output name as prediction output for a model
result_name<--method | Run iterator
run | Run iterator
run-method | Example iterator
run-method | Run iterator

## -- S --

seq_in | Sequence input
seq_in-method | model class
seq_in<- | Sequence input
seq_in<--method | model class
set_obj_method | update method for a struct object
set_obj_show | a helper function to update the show method for a struct object
set_struct_obj | define a new struct object
stato | get the stato_id for an object
stato_definition | get the stato_id for an object
stato_definition-method | get the stato_id for an object
stato_id | get the stato_id for an object
stato_id-method | get the stato_id for an object
stato_name | get the stato_id for an object
stato_name-method | get the stato_id for an object
stato_summary | get the stato_id for an object
stato_summary-method | get the stato_id for an object
struct | StRUCT: Statistics in R Using Class Templates
struct_class | Constructor for struct_class objects
struct_class-class | 'struct_class' object definition
struct_template | StRUCT templates

## -- T --

test_metric | Example metric
test_metric-class | Example metric

## -- V --

value | Calculate metric
value-method | get the max value vector length for an entity
value-method | Calculate metric
value<- | Calculate metric
value<--method | get the max value vector length for an entity
value<--method | Enum objects
value<--method | Calculate metric

## -- misc --

$-method | Get/set parameter or output values
$-method | DatasetExperiment class
$<--method | Get/set parameter or output values
$<--method | DatasetExperiment class
*-method | Run iterator
+-method | model_seq class
.struct_class | 'struct_class' object definition
[-method | Run iterator
[-method | model_seq class
[<--method | Run iterator
[<--method | model_seq class