capm (version 0.11.0)

DesignSurvey: Survey design

Description

A wraper for svydesign function from the survey package, to define one of the following survey designs: two-stage cluster, simple (systematic) or stratified. In the first case, weights are calculated considering a sample with probability proportional to size and with replacement for the first stage and a simple random sampling for the second stage. Finite population correction is specified as the population size for each level of sampling.

Usage

DesignSurvey(sample = NULL, psu.ssu = NULL, psu.col = NULL,
  ssu.col = NULL, cal.col = NULL, psu.2cd = NULL, N = NULL,
  strata = NULL, cal.N = NULL, ...)

Arguments

sample

data.frame with sample observations. for two-stage cluster designs, one of the columns must contain unique identifiers for PSU and another column must contain unique identifiers for Secondary Sampling Units (SSU).

psu.ssu

data.frame with all Primary Sampling Units (PSU). First column contains PSU unique identifiers. Second column contains numeric PSU sizes. It is used only for two-stage cluster designs.

psu.col

the column of sample containing the psu identifiers (for two-stage cluster designs). It is used only for two-stage cluster designs.

ssu.col

the column of sample containing the ssu identifiers (for two-stage cluster designs). It is used only for two-stage cluster designs.

cal.col

the column of sample with the variable to calibrate estimates. It must be used together with cal.N.

psu.2cd

for two-stage cluster designs, value indicating the number of psu included (for PSU included more than once, each must be counted).

N

for simple designs, a numeric value representing the total of sampling units in the population. for a stratified design, it is a column of sample indicating, for each observation, the total of sampling units in its respective strata. N is ignored in two-stage cluster designs.

strata

for stratified designs, a column of sample indicating the strata memebership of each observation.

cal.N

population total for the variable to calibrate the estimates. It must be used togheter with cal.col.

...

further arguments passed to svydesign function.

Value

An object of class survey.design.

Details

For two-stage cluster designs, a PSU appearing in both psu.ssu and in sample must have the same identifier. SSU identifiers must be unique but can appear more than once if there is more than one observation per SSU. sample argument must have just the varibles to be estimated plus the variables required to define the design (two-stage cluster or stratified). cal.col and cal.N are needed only if estimates will be calibrated. The calibration is based on a population total.

References

Lumley, T. (2011). Complex surveys: A guide to analysis using R (Vol. 565). Wiley.

http://oswaldosantos.github.io/capm

Examples

# NOT RUN {
data(city)
data(hh)
## Two-stage cluster design that included 65 PSU.
data(cluster_sample)
cluster_sample2 <- cluster_sample[complete.cases(cluster_sample), c(1:2, 8:10)]
DesignSurvey(sample = cluster_sample2,
             psu.ssu = city[, c("track_id", "hh")],
             psu.col = 1, ssu.col = 2, psu.2cd = 65,
             cal.col = 3, cal.N = sum(hh$persons))
#'
## Simple design.
data(sys_sample)
sys_sample2 <- sys_sample[complete.cases(sys_sample), 7:9]
DesignSurvey(sample = sys_sample[, -c(1:2)], N = sum(city$hh))

## Assuming that systematic_sample is a stratified design.
# Hypothetical strata
strat <- sys_sample2
strat$strat <- sample(c("urban", "rural"), nrow(strat), prob = c(.95, .05),
                      replace = TRUE)
strat$strat_size <- round(sum(city$hh) * .95)
strat$strat_size[strat$strat == "rural"] <- round(sum(city$hh) * .05)
DesignSurvey(strat, N = "strat_size", strata = "strat")

# }