Specify the parameters for a new IPUMS extract request object to be submitted via the IPUMS API. An extract request contains the specifications required to obtain a particular set of data from an IPUMS collection.
Learn more about the IPUMS API in vignette("ipums-api").
Supported collections
Currently, ipumsr supports extract definitions for the following collections:
IPUMS USA:
define_extract_usa()IPUMS CPS:
define_extract_cps()IPUMS International:
define_extract_ipumsi()IPUMS NHGIS:
define_extract_nhgis()
Value
These functions produce an ipums_extract object
with a subclass based on the collection corresponding to the extract request.
The core ipumsr API client tools are designed to handle these objects.