Skip to contents

Prepare university student target variable for weighting

prep_target_univstudent.Rd

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

Usage

prep_target_univstudent(
  h_data,
  p_data,
  target_name = "p_univstudent",
  codebook,
  settings
)

Arguments

h_data

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

p_data

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

  • For PUMS: must include SERIALNO, SCHG_label.

  • For survey: must include university student columns as specified in settings. Rows: one per person. Modified by reference: no (returns copy).

target_name

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

codebook

data.table. Codebook for variable mapping; must include university student value and label columns.

settings

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

Value

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

  • Columns: all original plus target_name (character)

  • Values: "yes" or "no"

  • Row order preserved

Details

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

  • For PUMS:

    • Uses SCHG_label column, converts to lowercase.

    • Uses regex college|graduate to identify university students.

    • Assigns target levels:

      • If label matches regex → "yes"

      • else → "no"

  • For survey:

    • Uses codebook to map survey input variables to values matching regex (?i)(full|part)-time student|college|graduate (case-insensitive).

    • Assigns target as "yes" if all relevant columns are true, else "no".

  • Checks that observed levels match expected target levels from settings.

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

  • 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[["p_univstudent"]] (direct): must include levels, survey_input.

See also

get_target_methods, prep_target_gender, prep_target_edulevel

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_h_size(), prep_target_income(), prep_target_kids(), prep_target_race(), prep_target_vehicles(), prep_target_workers(), prep_transit_target(), prepare_targets(), run_tabulate_method()

Examples

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