collect_weights: Extract the data with the computed weights
In weightflow: Declarative API for Staged Survey Weights

collect_weights

R Documentation

Extract the data with the computed weights

Description

Extract the data with the computed weights

Usage

collect_weights(
  object,
  drop_zero = TRUE,
  keep_intermediate = FALSE,
  weight_name = ".weight"
)

Arguments

`object`	a prepped object (output of prep()).
`drop_zero`	logical. If TRUE, drops rows with final weight 0 (ineligible / nonresponse). Default TRUE.
`keep_intermediate`	logical. If TRUE, adds one column per stage.
`weight_name`	name of the final weight column. Default ".weight".

Value

data.frame.

Examples

fitted <- weighting_spec(sample_survey, base_weights = pw) |>
  step_nonresponse(respondent = responded, method = "weighting_class", by = "region") |>
  prep()
head(collect_weights(fitted))

weightflow documentation built on July 23, 2026, 1:08 a.m.