Package index • ipumsr

Read IPUMS data

Load IPUMS data and metadata files into R

Microdata projects

read_ipums_micro() read_ipums_micro_list(): Read data from an IPUMS microdata extract

read_ipums_ddi(): Read metadata about an IPUMS microdata extract from a DDI codebook (.xml) file

read_ipums_micro_chunked() read_ipums_micro_list_chunked(): Read data from an IPUMS microdata extract by chunk

read_ipums_micro_yield() read_ipums_micro_list_yield(): Read data from an IPUMS microdata extract in yields

Aggregate data projects

read_ipums_agg(): Read data from an IPUMS aggregate data extract

read_nhgis_codebook() experimental: Read metadata from an NHGIS codebook (.txt) file

read_ihgis_codebook() experimental: Read metadata from an IHGIS extract's codebook files

General use

read_ipums_sf(): Read spatial data from an IPUMS extract

ipums_list_files(): List files contained within a zipped IPUMS extract

Interact with the IPUMS API

Request and download IPUMS data within R

define_extract_micro(): Define an extract request for an IPUMS microdata collection

define_extract_agg(): Define an extract request for an IPUMS aggregate data collection

get_metadata_catalog() catalog_types(): Retrieve a catalog of available data sources for an IPUMS collection

get_metadata(): Retrieve detailed metadata about an IPUMS data source

get_sample_info(): List available samples for IPUMS microdata collections

submit_extract(): Submit an extract request via the IPUMS API

wait_for_extract() is_extract_ready(): Wait for an extract request to finish processing

download_extract(): Download a completed IPUMS data extract

get_extract_info() get_last_extract_info(): Retrieve the definition and latest status of an extract request

get_extract_history(): Browse definitions of previously submitted extract requests

save_extract_as_json() define_extract_from_json(): Store an extract definition in JSON format

set_ipums_api_key(): Set your IPUMS API key

set_ipums_default_collection(): Set your default IPUMS collection

ipums_data_collections(): List IPUMS data collections

ipums_extract-class ipums_extract: ipums_extract class

download_supplemental_data(): Download IPUMS supplemental data files

Explore IPUMS variable metadata

Get additional information about IPUMS data contents

ipums_var_info() ipums_var_label() ipums_var_desc() ipums_val_labels(): Get contextual information about variables in an IPUMS data source

ipums_file_info() ipums_conditions(): Get file information for an IPUMS extract

ipums_view(): View a static webpage with variable metadata from an IPUMS extract

ipums_website(): Launch a browser window to an IPUMS metadata page

Work with value labels

Translate IPUMS value labels to standard R data structures

lbl_na_if(): Convert labelled data values to NA

lbl_relabel() lbl_collapse(): Modify value labels for a labelled vector

lbl_define(): Define labels for an unlabelled vector

zap_ipums_attributes(): Remove label attributes from a data frame or labelled vector

lbl_clean(): Clean unused labels

lbl_add() lbl_add_vals(): Add labels for unlabelled values

lbl(): Make a label placeholder object

Other helpers

Miscellaneous functions for working with IPUMS data

ipums_bind_rows(): Bind multiple data frames by row, preserving labelled attributes

ipums_shape_left_join() ipums_shape_right_join() ipums_shape_inner_join() ipums_shape_full_join(): Join tabular data to geographic boundaries

set_ipums_var_attributes(): Add IPUMS variable attributes to a data frame

ipums_collect(): Collect data into R session with IPUMS attributes

ipums_example(): Get path to IPUMS example datasets