Skip to contents

Get maximum survey income bin

get_max_survey_income_bin.Rd

Parse the survey codebook to get the maximum income bin for household income. Use to determine survey-based upper bound for income recoding.

Usage

get_max_survey_income_bin(settings, value_labels = NULL)

Arguments

settings

list. Project settings.

value_labels

data.table (optional). Must include:

  • variable — variable name

  • label — label text

  • value — bin value Keys: (variable, value).

Value

integer. Maximum income bin from survey codebook.

Details

  • Extracts max bin from value_labels for income_broad, income_followup, or income_detail.

  • Returns integer; does not modify by reference.

  • Assumes valid value_labels; errors if missing.

Settings

None.

See also

  • get_max_income_bin

Other recoding utilities: get_age_upper_bounds(), get_income_bounds(), get_max_acs_income_bin(), get_max_income_bin()

Examples

## Not run:
get_max_survey_income_bin(settings, value_labels)
#> Error: object 'value_labels' not found
## End(Not run)