ipums_file_info: Get file information for an IPUMS extract

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

Get file information for an IPUMS extract

Description

Get information about the IPUMS project, date, notes, conditions, and citation requirements for an extract based on an ipums_ddi object.

ipums_conditions() is a convenience function that provides conditions and citation information for a recently loaded dataset.

Usage

ipums_file_info(object, type = NULL)

ipums_conditions(object = NULL)

Arguments

object	An ipums_ddi object. For ipums_conditions(), leave NULL to display conditions for most recently loaded dataset.
type	Type of file information to display. If NULL, loads all types. Otherwise, one of "ipums_project", "extract_date", "extract_notes", "conditions" or "citation".

Value

For ipums_file_info(), if type = NULL, a named list of metadata information. Otherwise, a string containing the requested information.

Examples

ddi <- read_ipums_ddi(ipums_example("cps_00157.xml"))

ipums_file_info(ddi)

ipumsr documentation built on Oct. 20, 2023, 5:10 p.m.