summary function

Weighted Five-Number Summary of a Variable

Weighted five-number summary used for survey.design and survey.design2 objects (similar to base::summary

for [numeric vectors]).

svysummary(object, design, na.rm = FALSE, ...)

Arguments

• object: one-sided [formula] for which a summary is desired, e.g., ~payroll.
• design: an object of class survey.design; see svydesign.
• na.rm: [logical] indicating whether NA values should be removed before the computation proceeds (default: FALSE).
• ...: additional arguments.

Returns

A weighted five-number summary (numeric variable) or a frequency table (factor variable).

Examples

head(workplace)

library(survey)
# Survey design for stratified simple random sampling without replacement
dn <- if (packageVersion("survey") >= "4.2") {
        # survey design with pre-calibrated weights
        svydesign(ids = ~ID, strata = ~strat, fpc = ~fpc, weights = ~weight,
                  data = workplace, calibrate.formula = ~-1 + strat)
    } else {
        # legacy mode
        svydesign(ids = ~ID, strata = ~strat, fpc = ~fpc, weights = ~weight,
                  data = workplace)
    }

svysummary(~payroll, dn)