Skip to contents

Read PUMS data dictionary from tidycensus

read_pums_codebook.Rd

Read the PUMS data dictionary for specified variables and year using tidycensus. Use to retrieve variable metadata for PUMS processing and validation.

Usage

read_pums_codebook(settings, pums_vars = NULL, as_numeric = FALSE, fill = 0)

Arguments

settings

list. Must include:

  • pums_year — PUMS reference year

  • pums_dataset — PUMS dataset name Modified by reference: no.

pums_vars

character vector. PUMS variables to read. Default: all variables.

as_numeric

logical. Convert val_min and val_max to numeric. Default FALSE.

fill

numeric. Value to fill NAs. Default 0.

Value

data.table. PUMS codebook for requested variables and year.

Details

  • Loads codebook from tidycensus and updates for requested year if missing.

  • Filters for specified variables and year; supports numeric conversion and NA fill.

  • Returns a copy; does not modify by reference.

  • Assumes valid settings and year; errors if missing.

Settings

  • pums_year (direct): PUMS reference year. Default from settings.

  • pums_dataset (direct): PUMS dataset name. Default from settings.

See also

  • clean_data_dict

  • scripts/io/read_pums_codebook.R

Other io utilities: clean_data_dict(), cut_and_label(), db_table_has_geometry(), fetch_acs(), fetch_all_hts_tables(), fetch_from_db(), fetch_hts_table(), fetch_pums(), fetch_study_region(), find_project_root(), fix_value_labels_on_load(), get_db_table_name(), print_params(), pums_checksum(), read_from_db(), record_checksum(), sampled_latlon_to_bg()

Examples

## Not run:
read_pums_codebook(settings, pums_vars = c("AGEP", "SEX"))
#> Read PUMS codebook
#> Error: object 'settings' not found
## End(Not run)