Skip to contents

Extract Survey Design Information

Source: R/extract.R
extract_design.Rd

Extracts weights, cluster identifiers, and strata from survey design objects created by the survey package. The extracted information can be passed directly to der_compute().

Usage

extract_design(design, ...)

# S3 method for class 'survey.design2'
extract_design(design, ...)

# Default S3 method
extract_design(design, ...)

Arguments

design

A survey design object (class survey.design2).

...

Additional arguments passed to methods.

Value

A list with components:

weights

Numeric vector of survey weights.

cluster

Factor or integer vector of PSU/cluster identifiers.

strata

Data frame of strata variables (may be NULL for unstratified designs).

References

Lee, J., Williams, M. R., & Savitsky, T. D. (2026). Design Effect Ratios for Bayesian Survey Models: A Diagnostic Framework for Identifying Survey-Sensitive Parameters. Journal of Survey Statistics and Methodology. Submitted.

Rabe-Hesketh, S., & Skrondal, A. (2006). Multilevel modelling of complex survey data. Journal of the Royal Statistical Society: Series A, 169(4), 805–827. doi:10.1111/j.1467-985X.2006.00426.x

See also

extract_draws() for extracting posterior draws, der_compute() for computing DER.

Other backends: extract_draws.brmsfit()