ContControl-class: Class '"ContControl"'

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

Description

Virtual class for controlling contamination in a simulation experiment. It is used internally and is not expected to be extended by users.

Objects from the Class

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

Slots

target:

A character vector specifying specifying the variables (columns) to be contaminated, or NULL to contaminate all variables (except additional ones generated internally).

epsilon:

A numeric vector giving the contamination levels.

tuning:

A data frame giving tuning parameters for the contamination. A list is converted to a data frame during initialization via expand.grid.

indices:

An integer matrix in which the first column contains the indices of the contamination levels and the second column contains the row indices of the tuning parameters for the different contamination settings.

fun:

A function generating the values of the contaminated data. As its first argument, it should take either the number of observations to be created (if type is "CCAR") or the original values of the observations to be contaminated (if type is "CAR"). Furthermore, it should return an object that can be coerced to a data frame, containing the contaminated data.

dots:

A list containing additional arguments to be passed to fun.

type:

A character string specifying whether observations should be contaminated completely at random ("CCAR") or contaminated at random ("CAR").

Extends

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

Accessor methods

The following accessor methods are available in addition to the inherited ones:

getTuning

signature(x = "ContControl"): get slot tuning.

getIndices

signature(x = "ContControl"): get slot indices.

getFun

signature(x = "ContControl"): get slot fun.

getDots

signature(x = "ContControl"): get slot dots.

getType

signature(x = "ContControl"): get slot type.

Methods

The following methods are available in addition to the inherited ones:

length

signature(x = "ContControl"): get the number of different contamination settings to be used.

show

signature(object = "ContControl"): print the object on the R console.

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

"BasicContControl", "RandomContControl", contaminate


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