SimResults-class: Class "SimResults"

In aalfons/simFrame: Simulation Framework

Description

Class for simulation results.

Objects from the Class

Objects can be created by calls of the form new("SimResults", ...) or SimResults(...).

However, objects are expected to be created by the function runSimulation or clusterRunSimulation, these constructor functions are not supposed to be called by the user.

Slots

values:

Object of class "data.frame" containing the simulation results.

add:

Object of class "list" containing additional simulation results, e.g., statistical models.

design:

Object of class "character" giving the variables (columns) defining the domains used in the simulation experiment.

colnames:

Object of class "character" giving the names of the columns of values that contain the actual simulation results.

epsilon:

Object of class "numeric" containing the contamination levels used in the simulation experiment.

NArate:

Object of class "NumericMatrix" containing the missing value rates used in the simulation experiment.

dataControl:

Object of class "OptDataControl"; the control object used for data generation in model-based simulation, or NULL.

sampleControl:

Object of class "OptSampleControl"; the control object used for sampling in design-based simulation, or NULL.

nrep:

Object of class "numeric" giving the number of repetitions of the simulation experiment (for model-based simulation or simulation based on real data).

control:

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

seed:

Object of class "list" containing the seeds of the random number generator before and after the simulation experiment, respectively (for replication of the results).

call:

Object of class "SimCall"; the function call used to run the simulation experiment, or NULL.

Accessor methods

getValues

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

getAdd

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

getDesign

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

getColnames

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

getEpsilon

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

getNArate

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

getDataControl

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

getSampleControl

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

getNrep

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

getControl

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

getSeed

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

getCall

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

Methods

aggregate

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

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.

simBwplot

signature(x = "SimResults"): conditional box-and-whisker plot of simulation results.

simDensityplot

signature(x = "SimResults"): conditional kernel density plot of simulation results.

simXyplot

signature(x = "SimResults"): conditional x-y plot 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.

Note

There are no mutator methods available since the slots are not supposed to be changed by the user.

Furthermore, the slots dataControl, sampleControl, nrep and control were added in version 0.3.

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. doi: 10.18637/jss.v037.i03.

See Also

runSimulation, simBwplot, simDensityplot, simXyplot

Examples

showClass("SimResults")

aalfons/simFrame documentation built on Nov. 27, 2021, 7:51 a.m.