Skip to contents

CalmrExperiment methods

Source: R/class_experiment.R
CalmrExperiment-methods.Rd

S4 methods for CalmrExperiment class.

Usage

# S4 method for CalmrExperiment
show(object)

# S4 method for CalmrExperiment
design(x)

# S4 method for CalmrExperiment
trials(object)

# S4 method for CalmrExperiment
parameters(x)

# S4 method for CalmrExperiment
parameters(x) <- value

# S4 method for CalmrExperiment
experiences(x)

# S4 method for CalmrExperiment
experiences(x) <- value

# S4 method for CalmrExperiment
results(object)

# S4 method for CalmrExperiment
raw_results(object)

# S4 method for CalmrExperiment
parsed_results(object)

# S4 method for CalmrExperiment
length(x)

# S4 method for CalmrExperiment
parse(object, outputs = NULL)

# S4 method for CalmrExperiment
aggregate(x, outputs = NULL)

# S4 method for CalmrExperiment
plot(x, type = NULL, ...)

# S4 method for CalmrExperiment
graph(x, ...)

# S4 method for CalmrExperiment
timings(x)

# S4 method for CalmrExperiment
timings(x) <- value

Arguments

object, x

A CalmrExperiment object.

value

A list of parameters (or list of parameter lists).

outputs

A character vector specifying the model outputs to parse.

type

A character vector specifying the type(s) of plots to create. Defaults to NULL. See supported_plots.

...

Extra arguments passed to calmr_model_graph() and calmr_model_plot().

Value

show() returns NULL (invisibly).

design() returns the CalmrDesign contained in the object.

trials() returns NULL (invisibly).

parameters() returns the list of parameters contained in the object.

parameters()<- returns the object after updating parameters.

experiences() returns a list of data.frame objects containing model training routines.

experiences()<- returns the object after updating experiences.

results() returns a data.table objects with aggregated results.

raw_results() returns a list with raw model results.

parsed_results() returns a list of data.table

objects with parsed results.

length() returns an integer specifying the total length of the experiment (groups by iterations).

parse() returns the object after parsing raw results.

aggregate() returns the object after aggregating parsed results.

plot() returns a list of 'ggplot' plot objects.

graph() returns a list of 'ggplot' plot objects.

timings() returns the list of timings contained in the object.

timings()<- returns the object after updating timings.

See also

plotting_functions(),calmr_model_plot(),calmr_model_graph()