VirtualContControl-class {simFrame} | R Documentation |
Class "VirtualContControl"
Description
Virtual superclass for controlling contamination in a simulation experiment.
Objects from the Class
A virtual Class: No objects may be created from it.
Slots
target
:Object of class
"OptCharacter"
; a character vector specifying specifying the variables (columns) to be contaminated, orNULL
to contaminate all variables (except the additional ones generated internally).epsilon
:Object of class
"numeric"
giving the contamination levels.
Extends
Class "OptContControl"
, directly.
Accessor and mutator methods
getTarget
signature(x = "VirtualContControl")
: get slottarget
.setTarget
signature(x = "VirtualContControl")
: set slottarget
.getEpsilon
signature(x = "VirtualContControl")
: get slotepsilon
.setEpsilon
signature(x = "VirtualContControl")
: set slotepsilon
.
Methods
head
signature(x = "VirtualContControl")
: currently returns the object itself.length
signature(x = "VirtualContControl")
: get the number of contamination levels to be used.show
signature(object = "VirtualContControl")
: print the object on the R console.summary
signature(object = "VirtualContControl")
: currently returns the object itself.tail
signature(x = "VirtualContControl")
: currently returns the object itself.
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. doi: 10.18637/jss.v037.i03.
See Also
"DCARContControl"
, "DARContControl"
,
"ContControl"
, contaminate
Examples
showClass("VirtualContControl")