Function reference • ipumsr

Read IPUMS data
`read_ipums_micro()` `read_ipums_micro_list()`	Read data from an IPUMS extract
`read_nhgis()` `read_nhgis_sf()` `read_nhgis_sp()`	Read data from an NHGIS extract
`read_terra_area()` `read_terra_area_sf()` `read_terra_area_sp()`	Read data from an IPUMS Terra area extract
`read_terra_micro()`	Read data from an IPUMS Terra microdata extract
`read_terra_raster()` `read_terra_raster_list()`	Read data from an IPUMS Terra raster extract
`read_ipums_sf()` `read_ipums_sp()`	Read boundary files from an IPUMS extract
`read_ipums_ddi()`	Read metadata about an IPUMS extract from a DDI (.xml) file
`read_ipums_codebook()`	Read metadata from a text codebook in a NHGIS or Terra area-level extract
`read_ipums_micro_chunked()` `read_ipums_micro_list_chunked()`	Read data from an IPUMS extract (in chunks)
`read_ipums_micro_yield()` `read_ipums_micro_list_yield()`	Read data from an IPUMS extract (in yields)
Explore IPUMS metadata
`ipums_view()`	View a static webpage with variable information from a IPUMS extract
`ipums_var_info()` `ipums_var_desc()` `ipums_var_label()` `ipums_val_labels()`	Get IPUMS variable information
`ipums_website()`	Launch a browser window to the ipums website
`ipums_conditions()`	Get IPUMS citation and conditions
`ipums_file_info()`	Get IPUMS file information
`ipums_list_files()` `ipums_list_data()` `ipums_list_shape()` `ipums_list_raster()`	List files available for analysis in an IPUMS extract
Work with value labels Translate IPUMS value labels to standard R data structures
`lbl_na_if()`	Set labelled values to missing
`lbl_relabel()`	Relabel labelled values
`lbl_define()`	Define labels for an unlabelled vector
`lbl_collapse()`	Collapse labelled values to labels that already exist
`zap_ipums_attributes()`	Remove all IPUMS attributes from a variable (or all variables in a data.frame)
`lbl_clean()`	Clean unused labels
`lbl_add()` `lbl_add_vals()`	Add labels for unlabelled values
`lbl()`	Make a label placeholder object
Interact with the IPUMS API
`set_ipums_api_key()`	Set your IPUMS API key
`define_extract_usa()`	Define an IPUMS USA extract request
`define_extract_cps()`	Define an IPUMS CPS extract request
`ipums_extract-class`	`ipums_extract` class
`submit_extract()`	Submit an extract request via the IPUMS API
`wait_for_extract()`	Wait for extract to finish
`is_extract_ready()`	Is the extract ready to download?
`download_extract()`	Download an IPUMS data extract
`get_extract_info()`	Get information about a submitted extract
`get_last_extract_info()`	Get information on last extract
`get_recent_extracts_info_list()` `get_recent_extracts_info_tbl()`	Get information on recent extracts
`add_to_extract()`	Add values to an IPUMS USA or CPS extract
`remove_from_extract()`	Remove values from an IPUMS USA or CPS extract
`save_extract_as_json()`	Save an `ipums_extract` to disk as JSON
`define_extract_from_json()`	Create an `ipums_extract` object from a JSON-formatted definition
`ipums_data_collections()`	List IPUMS data collections
`extract_tbl_to_list()`	Convert a tibble of extract definitions to a list
`extract_list_to_tbl()`	Convert a list of extract definitions to a tibble
Other helpers Miscellaneous other helper functions for working with IPUMS data
`ipums_bind_rows()`	Bind rows together, but preserve labelled class attributes
`ipums_collect()`	Collect data into R session with IPUMS attributes
`ipums_example()`	Get path to ipums example datasets
`ipums_shape_left_join()` `ipums_shape_right_join()` `ipums_shape_inner_join()` `ipums_shape_full_join()`	Join data to geographic boundaries
`join_failures()`	Report on observations dropped by a join
`set_ipums_var_attributes()`	Add IPUMS variable attributes to a data.frame
`dplyr_select_style`	Select-style helpers from dplyr

Reference

Read IPUMS data

Explore IPUMS metadata

Work with value labels

Interact with the IPUMS API

Other helpers