srvyr (version 0.2.1)

as_survey: Create a tbl_svy from a data.frame

Description

as_survey can be used to create a tbl_svy using design information (as_survey_design), replicate weights (as_survey_rep), or a two phase design (as_survey_twophase), or an object created by the survey package. as_survey_ is its standard evaluation counterpart.

Usage

as_survey(.data, ...)

# S3 method for data.frame as_survey(.data, ...)

# S3 method for tbl_sql as_survey(.data, ...)

# S3 method for survey.design2 as_survey(.data, ...)

# S3 method for svyrepdesign as_survey(.data, ...)

# S3 method for twophase2 as_survey(.data, ...)

as_survey_(.data, ...)

Arguments

.data

a data.frame or an object from the survey package

...

other arguments, see other functions for details

Value

a tbl_svy

Details

There is also limited support for databases using dplyr's tbl_sql objects for survey designs and replicate weight surveys. Not all operations are available for these objects, in particular two phase designs do not work. See NA for more information on setting up databases in dplyr.

Examples

Run this code
# Examples from ?survey::svydesign
library(survey)
library(dplyr)
data(api)

# stratified sample
dstrata <- apistrat %>%
  as_survey(strata = stype, weights = pw)

# Examples from ?survey::svrepdesign
data(scd)
# use BRR replicate weights from Levy and Lemeshow
scd$rep1 <- 2 * c(1, 0, 1, 0, 1, 0)
scd$rep2 <- 2 * c(1, 0, 0, 1, 0, 1)
scd$rep3 <- 2 * c(0, 1, 1, 0, 0, 1)
scd$rep4 <- 2 * c(0, 1, 0, 1, 1, 0)

scdrep <- scd %>%
  as_survey(type = "BRR", repweights = starts_with("rep"),
                    combined_weights = FALSE)

# Examples from ?survey::twophase
# two-phase simple random sampling.
data(pbc, package="survival")

pbc <- pbc %>%
  mutate(randomized = !is.na(trt) & trt > 0,
         id = row_number())
d2pbc <- pbc %>%
  as_survey(id = list(id, id), subset = randomized)

# as_survey_ uses standard evaluation
dstrata <- apistrat %>%
  as_survey_(strata = "stype", weights = "pw")

Run the code above in your browser using DataCamp Workspace