Skip to contents

Survey quantile

svy_quantile.Rd

Survey quantile

Usage

svy_quantile(
  design,
  vars,
  quantiles = c(0.25, 0.5, 0.75),
  group = NULL,
  group_key_sep = " -/- ",
  na_rm = TRUE,
  vartype = "ci",
  level = 0.95,
  ...
)

Arguments

design

A srvyr::design object.

vars

A quoted vector of variables to calculate quantile from.

quantiles

A vector of quantiles to calculate

group

A quoted vector of columns to group by. Default to NULL for no group.

group_key_sep

A character string to separate grouping column names in a fancy 'group_key' column.

na_rm

Should NAs from var be removed? Default to TRUE.

vartype

NULL to report no variability. Otherwise one or more of: standard error ("se", the default), confidence interval ("ci"), variance ("var") or coefficient of variation ("cv").

level

A single number indicating the confidence level (only one level allowed). Note that this may effect estimated standard errors (see svyquantile details on alpha, which equals 1-level).

...

Other parameters to pass to srvyr::survey_quantile().

Value

A survey-summarized-mean data frame

See also

Other survey analysis functions: auto_svy_analysis(), svy_analysis(), svy_interact(), svy_mean(), svy_median(), svy_proportion(), svy_ratio()