ipumsr (version 0.4.5)

read_ipums_codebook: Read metadata from a text codebook in a NHGIS or Terra area-level extract

Description

Read text formatted codebooks provided by some IPUMS extract systems such as NHGIS and Terra Area-level extracts in a format analogous to the DDIs available for other projects.

Usage

read_ipums_codebook(cb_file, data_layer = NULL)

Arguments

cb_file

Filepath to the codebook (either the .zip file directly downloaded from the website, or the path to the unzipped .txt file).

data_layer

dplyr select-style notation for uniquely identifying the data layer to load. Required for reading from .zip files for extracts with multiple files.

Value

A ipums_ddi object with information on the variables included in the csv file of a NHGIS extract.

See Also

Other ipums_metadata: read_ipums_ddi()

Examples

# NOT RUN {
# Example NHGIS extract
nhgis_file <- ipums_example("nhgis0008_csv.zip")
ddi <- read_ipums_codebook(nhgis_file)
# }