An R Interface for Downloading, Reading, and Handling IPUMS Data
Overview
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.
Note: ipumsr now requires R version 4.1.0 or later.
New features
- Added API support for IPUMS DHS (
"dhs"). DHS extracts can now be defined (withdefine_extract_micro()), submitted (withsubmit_extract()), and downloaded (withdownload_extract()) via the IPUMS API using the same workflow as other microdata collections.
Function retirements
- Functions
define_extract_usa(),define_extract_cps(), anddefine_extract_ipumsi()are now defunct. Please usedefine_extract_micro()to define extracts for all microdata collections.
Bug fixes
- Improved parsing of labeled values included in "codInstr" tags in the DDI codebook for microdata extracts (#94).
From NEWS.md in the release
Install
Health
- OK13 OK2026-08-05
- NOTE12 OK, 1 NOTE2026-08-01
- OK13 OK2026-06-09
- ERROR12 OK, 1 ERROR2026-06-08
- OK14 OK2026-03-18
Show 1 earlier changeHide 1 earlier change
- ERROR10 OK, 4 ERROR2026-03-10
Documentation
- Help pages
- 58 (18 internal)includes a package overview page
- Examples that run
- 92%47 run in a plain check (2 of them under a condition) · 4 never run
- Exported functions with examples
- 92%
- Documented parameters
- 99%
- Return-value docs
- 96%
- Help pages citing references
- 0%
Downloads
Repository
- PRs merged (all time)
- 97%
- Median days to close, 50 most recently updated closed issues
- 6
- Median days to close, 50 most recently updated closed PRs
- 0
Stars over time
Forks over time
Releases over time
Issues over time
PRs over time
14 development-tooling and community-health practices detected across 8 families in the upstream repository
Checks run against github.com/ipums/ipumsr on 2026-10-21.
The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel
GitHub Pages site last deployed 2026-03-17 · The repository has a site deploy workflow
pkgdown site last built 2026-03-17
Show all practicesHide 4 practices
Dependencies
Installing ipumsr adds 41 packages (25 with compiled code, 27 MB of source tarballs). Heaviest: BH 14 MB, Rcpp 1.8 MB, openssl 1.1 MB.
Code & Tests
Datasets
People & History
Previously maintained by Greg Freedman Ellis (0.1.0 to 0.4.0).
Pick two releases to compare their code metrics.
- RR 4.6.0 released · 2026-04-24
- 0.10.0Latest
- 0.9.02025-06-04 · diff ↗ ·
removed 4 exports
extract_list_to_tbl, extract_tbl_to_list, get_recent_extracts_info_list, get_recent_extracts_info_tbladded 6 exports
catalog_types, define_extract_agg, get_metadata, get_metadata_catalog, read_ihgis_codebook, read_ipums_agg - RR 4.5.0 released · 2025-04-11
- 0.8.2
- 0.8.12024-07-17 · diff ↗
- 0.8.0
- RR 4.4.0 released · 2024-04-24
- 0.7.22024-03-12 · diff ↗
- 0.7.12024-02-26 · diff ↗
- 0.7.02023-10-20 · diff ↗ ·
removed 14 exports
ipums_list_data, ipums_list_raster, ipums_list_shape, make_ddi_from_scratch, read_ipums_codebook, read_ipums_sp, read_nhgis_sf, read_nhgis_sp, read_terra_area, read_terra_area_sf, read_terra_area_sp, read_terra_micro, read_terra_raster, read_terra_raster_list - 0.6.32023-09-02 · diff ↗
- 0.6.22023-08-23 · diff ↗
- 0.6.12023-08-18 · diff ↗
- 0.6.02023-07-21 · diff ↗ ·
added 16 exports
all_of, any_of, define_extract_ipumsi, define_extract_nhgis, ds_spec, get_extract_history, get_metadata_nhgis, get_sample_info, last_col, problems, read_nhgis_codebook, samp_spec, set_ipums_default_collection, spec, tst_spec, var_spec - RR 4.3.0 released · 2023-04-21
Show 19 earlier eventsHide 19 earlier events
- 0.5.22022-12-09 · diff ↗
- 0.5.12022-09-30 · diff ↗
- 0.5.02022-06-05 · diff ↗ ·
added 18 exports
add_to_extract, define_extract_cps, define_extract_from_json, define_extract_usa, download_extract, extract_list_to_tbl, extract_tbl_to_list, get_extract_info, get_last_extract_info, get_recent_extracts_info_list, get_recent_extracts_info_tbl, ipums_data_collections, is_extract_ready, remove_from_extract, save_extract_as_json, set_ipums_api_key, submit_extract, wait_for_extract - RR 4.2.0 released · 2022-04-22
- RR 4.1.0 released · 2021-05-18
- 0.4.52020-07-22 · diff ↗
- 0.4.42020-06-03 · diff ↗
- 0.4.3
- RR 4.0.0 released · 2020-04-24
- 0.4.22019-06-04 · diff ↗
- 0.4.12019-05-15 · diff ↗
- RR 3.6.0 released · 2019-04-26
- 0.4.02019-03-08 · diff ↗ ·
added 4 exports
IpumsListYield, IpumsLongYield, read_ipums_micro_list_yield, read_ipums_micro_yield - 0.3.02018-09-27 · diff ↗ ·
added 9 exports
IpumsBiglmCallback, IpumsChunkCallback, IpumsDataFrameCallback, IpumsListCallback, IpumsSideEffectCallback, ipums_bind_rows, ipums_collect, read_ipums_micro_chunked, read_ipums_micro_list_chunked - RR 3.5.0 released · 2018-04-23
- 0.2.02018-04-20 · diff ↗ ·
added 7 exports
%<-%, read_terra_area, read_terra_area_sf, read_terra_area_sp, read_terra_micro, read_terra_raster, read_terra_raster_list - 0.1.12017-12-15 · diff ↗
- 0.1.02017-11-14
- RR 3.4.0 released · 2017-04-21
Package metadata
- First published
- 2017-11-14
- Total releases
- 25 / 9 yrs
- License
- Mozilla Public License 2.0
- Minimum R
- ≥ 4.1
- Download size
- 4.5 MB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("ipumsr")This package has no citation file, so citation() returns this entry built from DESCRIPTION.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-25, which the citation names so these numbers can be found later. More on citing and the projects behind them.