setNA: Set missing values

Description Usage Arguments Details Value Methods Author(s) References See Also Examples

Description

Generic function for inserting missing values into data.

Usage

1
2
3
4
setNA(x, control, ...)

## S4 method for signature 'data.frame,NAControl'
setNA(x, control, i = 1)

Arguments

x

the data in which missing values should be inserted.

control

a control object inheriting from the virtual class "VirtualNAControl" or a character string specifying such a control class (the default being "NAControl").

i

an integer giving the index of the missing data setting to be used.

...

if control is a character string or missing, the slots of the control object may be supplied as additional arguments. See "NAControl" for details on the slots.

Details

In order to extend the framework by a user-defined control class "MyNAControl" (which must extend "VirtualNAControl"), a method setNA(x, control, i = 1) with signature 'data.frame, MyNAControl' needs to be implemented. It may also be necessary to implement a method length(x) with signature 'MyNAControl' that returns the number of different missing data settings.

Value

A data frame containing the data with missing values.

Methods

x = "data.frame", control = "character"

set missing values using a control class specified by the character string control. The slots of the control object may be supplied as additional arguments.

x = "data.frame", control = "missing"

set missing values using a control object of class "NAControl". Its slots may be supplied as additional arguments.

x = "data.frame", control = "NAControl"

set missing values as defined by the control object control.

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

"NAControl"

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
data("eusilcP")
eusilcP$age[eusilcP$age < 0] <- 0  # this actually occurs
sam <- draw(eusilcP[, c("id", "age", "eqIncome")], size = 20)

## using control objects
# missing completely at random
mcarc <- NAControl(target = "eqIncome", NARate = 0.2)
setNA(sam, mcarc)
# missing at random
marc <- NAControl(target = "eqIncome", NARate = 0.2, aux = "age")
setNA(sam, marc)
# missing not at random
mnarc <- NAControl(target = "eqIncome", 
    NARate = 0.2, aux = "eqIncome")
setNA(sam, mnarc)

## supply slots of control object as arguments
# missing completely at random
setNA(sam, target = "eqIncome", NARate = 0.2)
# missing at random
setNA(sam, target = "eqIncome", NARate = 0.2, aux = "age")
# missing not at random
setNA(sam, target = "eqIncome", NARate = 0.2, aux = "eqIncome")

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