Package: ipumsr 0.8.1.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.8.1.9000.tar.gz
ipumsr_0.8.1.9000.zip(r-4.5)ipumsr_0.8.1.9000.zip(r-4.4)ipumsr_0.8.1.9000.zip(r-4.3)
ipumsr_0.8.1.9000.tgz(r-4.4-any)ipumsr_0.8.1.9000.tgz(r-4.3-any)
ipumsr_0.8.1.9000.tar.gz(r-4.5-noble)ipumsr_0.8.1.9000.tar.gz(r-4.4-noble)
ipumsr_0.8.1.9000.tgz(r-4.4-emscripten)ipumsr_0.8.1.9000.tgz(r-4.3-emscripten)
ipumsr.pdf |ipumsr.html✨
ipumsr/json (API)
NEWS

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

Peer review:

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

On CRAN:

10.17 score 22 stars 692 scripts 3.1k downloads 90 exports 42 dependencies

Last updated 3 months agofrom:8d90062dc0. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKOct 13 2024
R-4.5-winOKOct 13 2024
R-4.5-linuxOKOct 13 2024
R-4.4-winOKOct 13 2024
R-4.4-macOKOct 13 2024
R-4.3-winOKOct 13 2024
R-4.3-macOKOct 13 2024

Exports:%<-%add_to_extractall_ofany_ofas_factorcontainsdefine_extract_cpsdefine_extract_from_jsondefine_extract_ipumsidefine_extract_microdefine_extract_nhgisdefine_extract_usadownload_extractds_specends_witheverythingextract_list_to_tblextract_tbl_to_listget_extract_historyget_extract_infoget_last_extract_infoget_metadata_nhgisget_recent_extracts_info_listget_recent_extracts_info_tblget_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_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:askpassBHbitbit64clicliprcpp11crayoncurldplyrfansiforcatsgenericsgluehavenhipreadhmshttrjsonlitelifecyclemagrittrmimeopensslpillarpkgconfigprettyunitsprogresspurrrR6Rcppreadrrlangsystibbletidyselecttzdbutf8vctrsvroomwithrxml2zeallot

Big IPUMS Data

Rendered fromipums-bigdata.Rmdusingknitr::rmarkdownon Oct 13 2024.

Last update: 2024-07-10
Started: 2018-07-16

Introduction to the IPUMS API for R Users

Rendered fromipums-api.Rmdusingknitr::rmarkdownon Oct 13 2024.

Last update: 2024-07-03
Started: 2021-11-08

IPUMS Data and R

Rendered fromipums.Rmdusingknitr::rmarkdownon Oct 13 2024.

Last update: 2024-07-09
Started: 2017-11-07

Microdata API Requests

Rendered fromipums-api-micro.Rmdusingknitr::rmarkdownon Oct 13 2024.

Last update: 2024-07-03
Started: 2023-07-19

NHGIS API Requests

Rendered fromipums-api-nhgis.Rmdusingknitr::rmarkdownon Oct 13 2024.

Last update: 2024-07-15
Started: 2023-07-19

Reading IPUMS Data

Rendered fromipums-read.Rmdusingknitr::rmarkdownon Oct 13 2024.

Last update: 2024-07-03
Started: 2023-03-16

Value Labels in IPUMS data

Rendered fromvalue-labels.Rmdusingknitr::rmarkdownon Oct 13 2024.

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

Readme and manuals

Help Manual

Help pageTopics
Define an extract request for an IPUMS microdata collectiondefine_extract_cps define_extract_ipumsi define_extract_micro define_extract_usa
Define an IPUMS NHGIS extract requestdefine_extract_nhgis
Download a completed IPUMS data extractdownload_extract
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
List available data sources from IPUMS NHGISget_metadata_nhgis
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 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 tabular data from an NHGIS extractread_nhgis
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