Skip to contents

Prepare household size target variable for weighting

prep_target_h_size.Rd

Creates a standardized household size target variable for household-level weighting and expansion, using either PUMS or survey input. Use when preparing household size targets for synthetic population or survey analysis.

Usage

prep_target_h_size(h_data, p_data, target_name = "h_size", codebook, settings)

Arguments

h_data

data.table. Household-level input. Required columns:

  • For PUMS: must include SERIALNO and household size column as specified in settings.

  • For survey: must include household size column as specified in settings. Rows: one per household. Modified by reference: no (returns copy).

p_data

data.table. Person-level input (not used, included for interface consistency).

target_name

character(1). Name of the target variable to create (default: "h_size").

codebook

data.table. Codebook for variable mapping (not used in this function).

settings

list. Project settings; must include targets[[target_name]] with levels, pums_input, and survey_input.

Value

data.table. Copy of household-level input with new target variable column (target_name).

  • Columns: all original plus target_name (character)

  • Values: standardized household size bins

  • Row order preserved

Details

  • Detects input type (PUMS vs. survey) by presence of SERIALNO column in h_data.

  • Selects household size column using target_list$pums_input (PUMS) or target_list$survey_input (survey).

  • Applies cut_and_label to bin household size into target levels.

  • Renames output column to target_name (default: h_size).

  • Returns a copy of the input data.table with the new target variable.

  • Error handling: stops if levels do not match expected values.

Settings

  • targets[["h_size"]] (direct): must include levels, pums_input, and survey_input.

See also

get_target_methods, prep_target_income, prep_target_workers

Other target preparation: get_target_methods(), prep_target_adults(), prep_target_age(), prep_target_commutemode(), prep_target_cross(), prep_target_edulevel(), prep_target_employment(), prep_target_ethnicity(), prep_target_gender(), prep_target_income(), prep_target_kids(), prep_target_race(), prep_target_univstudent(), prep_target_vehicles(), prep_target_workers(), prep_transit_target(), prepare_targets(), run_tabulate_method()

Examples

## Not run:
prep_target_h_size(h_data, p_data, target_name = "h_size", codebook, settings)
#> Error: object 'h_data' not found
## End(Not run)