ContControl-class: Class "ContControl"
In aalfons/simFrame: Simulation Framework

Description Objects from the Class Slots Extends Accessor and mutator methods Methods UML class diagram Note Author(s) References See Also Examples

Virtual class for controlling contamination in a simulation experiment (used internally).

A virtual Class: No objects may be created from it.

target:: Object of class "OptCharacter"; a character vector specifying specifying the variables (columns) to be contaminated, or NULL to contaminate all variables (except the additional ones generated internally).
epsilon:: Object of class "numeric" giving the contamination levels.
grouping:: Object of class "character" specifying a grouping variable (column) to be used for contaminating whole groups rather than individual observations.
aux:: Object of class "character" specifying an auxiliary variable (column) whose values are used as probability weights for selecting the items (observations or groups) to be contaminated.

Class "VirtualContControl", directly. Class "OptContControl", by class "VirtualContControl", distance 2.

In addition to the accessor and mutator methods for the slots inherited from "VirtualContControl", the following are available:

getGrouping: signature(x = "ContControl"): get slot grouping.
setGrouping: signature(x = "ContControl"): set slot grouping.
getAux: signature(x = "ContControl"): get slot aux.
setAux: signature(x = "ContControl"): set slot aux.

In addition to the methods inherited from "VirtualContControl", the following are available:

contaminate: signature(x = "data.frame", control = "ContControl"): contaminate data.
show: signature(object = "ContControl"): print the object on the R console.

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.

The slot grouping was named group prior to version 0.2. Renaming the slot was necessary since accessor and mutator functions were introduced in this version and a function named getGroup already exists.

Andreas Alfons

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.

"DCARContControl", "DARContControl", "VirtualContControl", contaminate