manageSimPopObj: get and set variables from population or sample data stored...

In simPop: Simulation of Complex Synthetic Data Information

get and set variables from population or sample data stored in an object of class simPopObj.

Description

This functions allows to get or set variables in slots pop and sample of simPopObj-objects. This is a utility function that is useful for writing custom wrapper functions.

Usage

manageSimPopObj(x, var, sample = FALSE, set = FALSE, values = NULL)

Arguments

x	an object of class simPopObj.
var	character vector of length 1; variable name that should be set or extracted.
sample	a logical indicating whether var should be extracted/set from slot 'sample' (TRUE) or slot 'pop' (FALSE).
set	logical; if TRUE, argument 'values' is set to either the sample or population data stored in 'x', depending on argument 'sample'. If FALSE, the desired variable given by 'var' is returned from either the sample or the pop slot of 'x'.
values	vector; if 'set' is TRUE, then this vector is used to update the variable of sample or population data depending of choice of argument 'sample'.

Value

An object of class simPopObj (if 'set' is TRUE) or a vector (if 'set' is FALSE).

Author(s)

Bernhard Meindl and Matthias Templ

Examples

data(eusilcS)
inp <- specifyInput(data=eusilcS, hhid="db030", hhsize="hsize", strata="db040",
  weight="db090")
simPopObj <- simStructure(data=inp, method="direct", basicHHvars=c("age", "rb090"))

(manageSimPopObj(simPopObj, var="age", sample=FALSE, set=FALSE))
(manageSimPopObj(simPopObj, var="age", sample=TRUE, set=FALSE))

simPop documentation built on Nov. 10, 2022, 5:43 p.m.