SimResults-class: Class '"SimResults"'

Description Objects from the Class Slots Accessor methods Methods UML class diagram Author(s) References See Also

Description

Class for simulation results.

Objects from the Class

Objects can be created by calls of the form SimResults(...). However, the constructor function is not supposed to be called directly by the user.

Instead, objects are expected to be created by the function runSimulation.

Slots

values:

A data frame containing the simulation results.

colnames:

A character vector giving the names of the columns of values that contain the actual simulation results.

info:

A numeric vector giving the number of configurations for different controls of the simulation experiment.

dataControl:

The control object used for data generation (inheriting from class "VirtualDataControl"), or NULL.

sampleControl:

The control object used for sampling (inheriting from class "VirtualSampleControl"), or NULL.

nrep:

An integer giving the number of repetitions of the simulation experiment (if applicable).

control:

The control object of class "SimControl" used for running the simulations.

call:

The function call used to run the simulation experiment, or NULL.

Accessor methods

getValues

signature(x = "SimResults"): get slot values.

getColnames

signature(x = "SimResults"): get slot colnames.

getInfo

signature(x = "SimResults"): get slot info.

getControl

signature(x = "SimResults"): get control objects of a simulation experiment.

getNrep

signature(x = "SimResults"): get slot nrep.

getCall

signature(x = "SimResults"): get slot call.

Methods

aggregate

signature(x = "SimResults"): aggregate simulation results.

autoplot

signature(object = "SimResults"): selects a suitable graphical representation of the simulation results automatically.

fortify

signature(model = "SimResults"): convert simulation results to a data frame for plotting.

head

signature(x = "SimResults"): returns the first parts of simulation results.

plot

signature(x = "SimResults", y = "missing"): selects a suitable graphical representation of the simulation results automatically.

show

signature(object = "SimResults"): print simulation results on the R console.

simPlot

signature(object = "SimResults"): selects a suitable graphical representation of the simulation results automatically.

subset

signature(x = "SimResults"): take a subset of simulation results.

summary

signature(x = "SimResults"): produce a summary of simulation results.

tail

signature(x = "SimResults"): returns the last parts of simulation results.

UML class diagram

A slightly simplified UML class diagram of the framework can be found in Figure 1 of the package vignette An Object-Oriented Framework for Statistical Simulation: The R Package simFrame. Use vignette("simFrame-intro") to view this vignette.

Author(s)

Andreas Alfons

References

Alfons, A., Templ, M. and Filzmoser, P. (2010) An Object-Oriented Framework for Statistical Simulation: The R Package simFrame. Journal of Statistical Software, 37(3), 1–36. URL http://www.jstatsoft.org/v37/i03/.

See Also

runSimulation, simPlot


aalfons/simFrame documentation built on June 3, 2017, 10:52 a.m.