# An R Interface for Downloading, Reading, and Handling IPUMS Data

## Documentation for package ‘ipumsr’ version 0.9.0

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS
- Package README

## Help Pages

catalog_types | Retrieve a catalog of available data sources for an IPUMS collection
define_extract_agg | Define an extract request for an IPUMS aggregate data collection
define_extract_cps | Define an extract request for an IPUMS microdata collection
define_extract_from_json | Store an extract definition in JSON format
define_extract_ipumsi | Define an extract request for an IPUMS microdata collection
define_extract_micro | Define an extract request for an IPUMS microdata collection
define_extract_usa | Define an extract request for an IPUMS microdata collection
download_extract | Download a completed IPUMS data extract
download_supplemental_data | Download IPUMS supplemental data files
get_extract_history | Browse definitions of previously submitted extract requests
get_extract_info | Retrieve the definition and latest status of an extract request
get_last_extract_info | Retrieve the definition and latest status of an extract request
get_metadata | Retrieve detailed metadata about an IPUMS data source
get_metadata_catalog | Retrieve a catalog of available data sources for an IPUMS collection
IpumsListYield | Read data from an IPUMS microdata extract in yields
IpumsLongYield | Read data from an IPUMS microdata extract in yields
ipums_bind_rows | Bind multiple data frames by row, preserving labelled attributes
ipums_collect | Collect data into R session with IPUMS attributes
ipums_conditions | Get file information for an IPUMS extract
ipums_data_collections | List IPUMS data collections
ipums_example | Get path to IPUMS example datasets
ipums_extract | 'ipums_extract' class
ipums_extract-class | 'ipums_extract' class
ipums_file_info | Get file information for an IPUMS extract
ipums_list_files | List files contained within a zipped IPUMS extract
ipums_shape_full_join | Join tabular data to geographic boundaries
ipums_shape_inner_join | Join tabular data to geographic boundaries
ipums_shape_join | Join tabular data to geographic boundaries
ipums_shape_left_join | Join tabular data to geographic boundaries
ipums_shape_right_join | Join tabular data to geographic boundaries
ipums_val_labels | Get contextual information about variables in an IPUMS data source
ipums_var_desc | Get contextual information about variables in an IPUMS data source
ipums_var_info | Get contextual information about variables in an IPUMS data source
ipums_var_label | Get contextual information about variables in an IPUMS data source
ipums_view | View a static webpage with variable metadata from an IPUMS extract
ipums_website | Launch a browser window to an IPUMS metadata page
is_extract_ready | Wait for an extract request to finish processing
lbl | Make a label placeholder object
lbl_add | Add labels for unlabelled values
lbl_add_vals | Add labels for unlabelled values
lbl_clean | Clean unused labels
lbl_collapse | Modify value labels for a labelled vector
lbl_define | Define labels for an unlabelled vector
lbl_na_if | Convert labelled data values to NA
lbl_relabel | Modify value labels for a labelled vector
read_ihgis_codebook | Read metadata from an IHGIS extract's codebook files
read_ipums_agg | Read data from an IPUMS aggregate data extract
read_ipums_ddi | Read metadata about an IPUMS microdata extract from a DDI codebook (.xml) file
read_ipums_micro | Read data from an IPUMS microdata extract
read_ipums_micro_chunked | Read data from an IPUMS microdata extract by chunk
read_ipums_micro_list | Read data from an IPUMS microdata extract
read_ipums_micro_list_chunked | Read data from an IPUMS microdata extract by chunk
read_ipums_micro_list_yield | Read data from an IPUMS microdata extract in yields
read_ipums_micro_yield | Read data from an IPUMS microdata extract in yields
read_ipums_sf | Read spatial data from an IPUMS extract
read_nhgis_codebook | Read metadata from an NHGIS codebook (.txt) file
save_extract_as_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
set_ipums_var_attributes | Add IPUMS variable attributes to a data frame
submit_extract | Submit an extract request via the IPUMS API
wait_for_extract | Wait for an extract request to finish processing
zap_ipums_attributes | Remove label attributes from a data frame or labelled vector