ipumsr (version 0.4.5)

ipums_file_info: Get IPUMS file information

Description

Get IPUMS metadata information about the data file loaded into R from an ipums_ddi

Usage

ipums_file_info(object, type = NULL)

Arguments

object

An ipums_ddi object (loaded with read_ipums_ddi).

type

NULL to load all types, or one of "ipums_project", "extract_data", "extract_notes", "conditions" or "citation".

Value

If type is NULL, a list with the ipums_project, extract_date, extract_notes, conditions, and citation. Otherwise a string with the type of information requested in type.

Examples

# NOT RUN {
ddi <- read_ipums_ddi(ipums_example("cps_00006.xml"))
ipums_file_info(ddi)
# }