surveycore (version 0.8.3)

survey_taylor: Taylor Series Linearization Survey Design

Description

A survey design object using Taylor series (linearization) for variance estimation. Create with as_survey().

Usage

survey_taylor(
  data = data.frame(),
  metadata = survey_metadata(),
  variables = list(),
  groups = character(0),
  call = NULL
)

Value

A survey_taylor object.

Arguments

data

A data.frame containing the survey data. Prefer as_survey() over calling this constructor directly.

metadata

A survey_metadata object. Created automatically by as_survey().

variables

A named list of design specification (ids, weights, strata, fpc, nest, probs_provided). Set automatically by as_survey().

groups

Set by surveytidy's group_by(). Always character(0) in standalone surveycore use.

call

Language object capturing the construction call.

Design variables (<code>@variables</code>)

ids

Character vector of cluster ID column names, or NULL for simple random sampling.

weights

Character string naming the weight column.

strata

Character string naming the strata column, or NULL.

fpc

Character string naming the finite population correction column, or NULL.

nest

Logical. TRUE if cluster IDs are nested within strata (i.e., the same ID value in two strata refers to two distinct PSUs).

probs_provided

Logical. TRUE if the user supplied probs rather than weights to as_survey().

See Also

as_survey() to create a survey_taylor object.

Other constructors: as_survey(), as_survey_nonprob(), as_survey_replicate(), as_survey_twophase(), survey_data(), survey_glm(), survey_glm_fit(), survey_nonprob(), survey_replicate(), survey_twophase()

Examples

# Prefer as_survey() over calling survey_taylor() directly
d <- as_survey(gss_2024, ids = vpsu, weights = wtssps,
               strata = vstrat, nest = TRUE)
class(d)