VirtualNAControl-class: Class "VirtualNAControl"

In aalfons/simFrame: Simulation Framework

Description

Virtual superclass for controlling the insertion of missing values 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 the variables (columns) in which missing values should be inserted, or NULL to insert missing values in all variables (except the additional ones generated internally).

NArate:

Object of class "NumericMatrix" giving the missing value rates, which may be selected individually for the target variables. In case of a vector, the same missing value rates are used for all target variables. In case of a matrix, on the other hand, the missing value rates to be used for each target variable are given by the respective column.

Extends

Class "OptNAControl", directly.

Accessor and mutator methods

getTarget

signature(x = "VirtualNAControl"): get slot target.

setTarget

signature(x = "VirtualNAControl"): set slot target.

getNArate

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

setNArate

signature(x = "VirtualNAControl"): set slot NArate.

Methods

head

signature(x = "VirtualNAControl"): currently returns the object itself.

length

signature(x = "VirtualNAControl"): get the number of missing value rates to be used (the length in case of a vector or the number of rows in case of a matrix).

show

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

summary

signature(object = "VirtualNAControl"): currently returns the object itself.

tail

signature(x = "VirtualNAControl"): 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

"NAControl", setNA

Examples

showClass("VirtualNAControl")

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