Package: ipumsr 0.10.0.9000

Derek Burk

ipumsr: An R Interface for Downloading, Reading, and Handling IPUMS Data

An easy way to work with census, survey, and geographic data provided by IPUMS in R. Generate and download data through the IPUMS API and load IPUMS files into R with their associated metadata to make analysis easier. IPUMS data describing 1.4 billion individuals drawn from over 750 censuses and surveys is available free of charge from the IPUMS website <https://www.ipums.org>.

Authors:Greg Freedman Ellis [aut], Derek Burk [aut, cre], Finn Roberts [aut], Joe Grover [ctb], Dan Ehrlich [ctb], Renae Rodgers [ctb], Institute for Social Research and Data Innovation [cph]

ipumsr_0.10.0.9000.tar.gz
ipumsr_0.10.0.9000.zip(r-4.7)ipumsr_0.10.0.9000.zip(r-4.6)ipumsr_0.10.0.9000.zip(r-4.5)
ipumsr_0.10.0.9000.tgz(r-4.6-any)ipumsr_0.10.0.9000.tgz(r-4.5-any)
ipumsr_0.10.0.9000.tar.gz(r-4.7-any)ipumsr_0.10.0.9000.tar.gz(r-4.6-any)
ipumsr_0.10.0.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
ipumsr/json (API)

# Install 'ipumsr' in R:
install.packages('ipumsr', repos = c('https://ar-puuk.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/ipums/ipumsr/issues

Pkgdown/docs site:https://tech.popdata.org

On CRAN:

Conda:

11.63 score 42 stars 3 packages 940 scripts 6.2k downloads 93 exports 41 dependencies

Last updated from:bb3c866586. Checks:9 OK. Indexed: no.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK224
source / vignettesOK267
linux-release-x86_64OK236
macos-release-arm64OK159
macos-oldrel-arm64OK165
windows-develOK188
windows-releaseOK173
windows-oldrelOK197
wasm-releaseOK142

Exports:%<-%add_to_extractall_ofany_ofas_factorcatalog_typescontainsdefine_extract_aggdefine_extract_cpsdefine_extract_from_jsondefine_extract_ipumsidefine_extract_microdefine_extract_nhgisdefine_extract_usadownload_extractdownload_supplemental_datads_specends_witheverythingget_extract_historyget_extract_infoget_last_extract_infoget_metadataget_metadata_catalogget_metadata_nhgisget_sample_infoipums_bind_rowsipums_collectipums_conditionsipums_data_collectionsipums_exampleipums_file_infoipums_list_filesipums_shape_full_joinipums_shape_inner_joinipums_shape_left_joinipums_shape_right_joinipums_val_labelsipums_var_descipums_var_infoipums_var_labelipums_viewipums_websiteIpumsBiglmCallbackIpumsChunkCallbackIpumsDataFrameCallbackIpumsListCallbackIpumsListYieldIpumsLongYieldIpumsSideEffectCallbackis_extract_readyis.labelledjoin_failureslast_collbllbl_addlbl_add_valslbl_cleanlbl_collapselbl_definelbl_na_iflbl_relabelmatchesnum_rangeone_ofproblemsread_ihgis_codebookread_ipums_aggread_ipums_ddiread_ipums_microread_ipums_micro_chunkedread_ipums_micro_listread_ipums_micro_list_chunkedread_ipums_micro_list_yieldread_ipums_micro_yieldread_ipums_sfread_nhgisread_nhgis_codebookremove_from_extractsamp_specsave_extract_as_jsonset_ipums_api_keyset_ipums_default_collectionset_ipums_var_attributesspecstarts_withsubmit_extracttst_spectu_var_specvar_specwait_for_extractzap_ipums_attributeszap_labels

Dependencies:askpassBHbitbit64clicliprcpp11crayoncurldplyrforcatsgenericsgluehavenhipreadhmshttrjsonlitelifecyclemagrittrmimeopensslpillarpkgconfigprettyunitsprogresspurrrR6Rcppreadrrlangsystibbletidyselecttzdbutf8vctrsvroomwithrxml2zeallot

Big IPUMS Data
Setup | Option 1: Trade money for convenience | Option 2: Reduce extract size | Remove unused data | Select cases | Use a sampled subset of the data | Option 3: Process the data in pieces | Reading chunked data | Chunked tabulation | Chunked regression | Reading yielded data | Yielded tabulation | Yielded GLM regression | Option 4: Use a database | Importing data into the database | Connecting to a database with dbplyr | Learning more
Rendered fromipums-bigdata.Rmdusingknitr::rmarkdown

Last update: 2026-03-12
Started: 2018-07-16

Introduction to the IPUMS API for R Users
API availability | Set up your API key | Define an extract request | Extract request objects | Submit an extract request | Wait for an extract request to complete | Download an extract | Get info on past extracts | Share an extract definition | Revise a previous extract request | Putting it all together
Rendered fromipums-api.Rmdusingknitr::rmarkdown

Last update: 2026-02-11
Started: 2021-11-08

IPUMS Data and R
Obtaining IPUMS data | Obtaining data via an IPUMS project website | Downloading from microdata projects | Downloading from aggregate data projects | Obtaining data via the IPUMS API | Extract support | Metadata support | Workflow | Reading IPUMS data | Microdata files | NHGIS files | Spatial boundary files | Ancillary files | Exploring file metadata | Labelled values
Rendered fromipums.Rmdusingknitr::rmarkdown

Last update: 2026-02-11
Started: 2017-11-07

Microdata API Requests
Supported microdata collections | Basic IPUMS microdata concepts | IPUMS microdata metadata | Defining an IPUMS microdata extract request | Detailed variable specifications | Syntax | Case selections | Attached characteristics | Data quality flags | Monetary value adjustment | Time use variables | Data structure | Data file format | Next steps
Rendered fromipums-api-micro.Rmdusingknitr::rmarkdown

Last update: 2026-02-11
Started: 2023-07-19

Aggregate Data API Requests
Basic IPUMS aggregate data concepts | Metadata for aggregate data projects | Summary metadata | Detailed metadata | Defining an IPUMS aggregate data extract request | Basic extract definitions | Dataset specifications | Time series table specifications | Shapefile specifications | Invalid specifications | More complicated extract definitions | Data layout and file format | Next steps
Rendered fromipums-api-agg.Rmdusingknitr::rmarkdown

Last update: 2025-05-30
Started: 2025-05-30

Reading IPUMS Data
IPUMS extract structure | Reading IPUMS microdata extracts | Hierarchical extracts | Reading IPUMS aggregate data extracts | Variable metadata | Handling multiple files | Reading spatial data | Harmonized vs. non-harmonized data
Rendered fromipums-read.Rmdusingknitr::rmarkdown

Last update: 2025-05-30
Started: 2023-03-16

Value Labels in IPUMS data
IPUMS variable metadata | Value labels | labelled vs. factor | Cautions regarding labelled variables | Prepping data with value labels | Convert labelled values to other data types | Create missing values based on value labels | Syntax for value label functions | Relabel values | Relabeling caveats | Remove unused value labels | Add new labels | Other resources
Rendered fromvalue-labels.Rmdusingknitr::rmarkdown

Last update: 2024-07-24
Started: 2017-09-22

Readme and manuals

Help Manual

Help pageTopics
Define an extract request for an IPUMS aggregate data collectiondefine_extract_agg
Define an extract request for an IPUMS microdata collectiondefine_extract_cps define_extract_ipumsi define_extract_micro define_extract_usa
Download a completed IPUMS data extractdownload_extract
Download IPUMS supplemental data filesdownload_supplemental_data
Browse definitions of previously submitted extract requestsget_extract_history
Retrieve the definition and latest status of an extract requestget_extract_info get_last_extract_info
Retrieve detailed metadata about an IPUMS data sourceget_metadata
Retrieve a catalog of available data sources for an IPUMS collectioncatalog_types get_metadata_catalog
Bind multiple data frames by row, preserving labelled attributesipums_bind_rows
Collect data into R session with IPUMS attributesipums_collect
List IPUMS data collectionsipums_data_collections
Get path to IPUMS example datasetsipums_example
'ipums_extract' classipums_extract ipums_extract-class
Get file information for an IPUMS extractipums_conditions ipums_file_info
List files contained within a zipped IPUMS extractipums_list_files
Join tabular data to geographic boundariesipums_shape_full_join ipums_shape_inner_join ipums_shape_join ipums_shape_left_join ipums_shape_right_join
Get contextual information about variables in an IPUMS data sourceipums_val_labels ipums_var_desc ipums_var_info ipums_var_label
View a static webpage with variable metadata from an IPUMS extractipums_view
Launch a browser window to an IPUMS metadata pageipums_website
Make a label placeholder objectlbl
Add labels for unlabelled valueslbl_add lbl_add_vals
Clean unused labelslbl_clean
Define labels for an unlabelled vectorlbl_define
Convert labelled data values to NAlbl_na_if
Modify value labels for a labelled vectorlbl_collapse lbl_relabel
Read metadata from an IHGIS extract's codebook filesread_ihgis_codebook
Read data from an IPUMS aggregate data extractread_ipums_agg
Read metadata about an IPUMS microdata extract from a DDI codebook (.xml) fileread_ipums_ddi
Read data from an IPUMS microdata extractread_ipums_micro read_ipums_micro_list
Read data from an IPUMS microdata extract by chunkread_ipums_micro_chunked read_ipums_micro_list_chunked
Read data from an IPUMS microdata extract in yieldsIpumsListYield IpumsLongYield read_ipums_micro_list_yield read_ipums_micro_yield
Read spatial data from an IPUMS extractread_ipums_sf
Read metadata from an NHGIS codebook (.txt) fileread_nhgis_codebook
Store an extract definition in JSON formatdefine_extract_from_json save_extract_as_json
Set your IPUMS API keyset_ipums_api_key
Set your default IPUMS collectionset_ipums_default_collection
Add IPUMS variable attributes to a data frameset_ipums_var_attributes
Submit an extract request via the IPUMS APIsubmit_extract
Wait for an extract request to finish processingis_extract_ready wait_for_extract
Remove label attributes from a data frame or labelled vectorzap_ipums_attributes