specifyInput {simPop} | R Documentation |
create an object of class 'dataObj' required for further processing
Description
create an standardized input object of class 'dataObj' containing
information on weights, household ids, household sizes, person ids and
optionally strata. Outputs of this function are typically used in
simStructure
.
Usage
specifyInput(
data,
hhid,
hhsize = NULL,
pid = NULL,
weight = NULL,
strata = NULL,
population = FALSE
)
Arguments
data |
a |
hhid |
character vector of length 1 specifying variable containing
household ids within slot |
hhsize |
character vector of length 1 specifying variable containing
household sizes within slot |
pid |
character vector of length 1 specifying variable containing
person ids within slot |
weight |
character vector of length 1 specifying variable holding
sampling weights within slot |
strata |
character vector of length 1 specifing variable name within
slot |
population |
TRUE/FALSE vector of length 1 specifing if the data object is a sample or a population NULL if such variable does not exist. |
Author(s)
Bernhard Meindl
References
M. Templ, B. Meindl, A. Kowarik, A. Alfons, O. Dupriez (2017) Simulation of Synthetic Populations for Survey Data Considering Auxiliary Information. Journal of Statistical Survey, 79 (10), 1–38. doi:10.18637/jss.v079.i10
Examples
data(eusilcS)
inp <- specifyInput(data=eusilcS, hhid="db030", weight="rb050", strata="db040")
class(inp)
inp