Get information about a submitted extract via the IPUMS API. For an overview
of ipumsr API functionality, see vignette("ipums-api", package = "ipumsr").
get_extract_info(extract, api_key = Sys.getenv("IPUMS_API_KEY"))
| extract | One of:
The extract number does not need to be zero-padded (e.g., use |
|---|---|
| api_key | API key associated with your user account. Defaults to the value of environment variable "IPUMS_API_KEY". |
An ipums_extract object.
Other ipums_api:
define_extract_from_json(),
define_extract_micro(),
download_extract(),
extract_list_to_tbl(),
extract_tbl_to_list(),
get_last_extract_info(),
get_recent_extracts_info,
ipums_data_collections(),
is_extract_ready(),
revise_extract_micro(),
save_extract_as_json(),
submit_extract(),
wait_for_extract()
my_extract <- define_extract_micro("usa", "Example", "us2013a", "YEAR") if (FALSE) { submitted_extract <- submit_extract(my_extract) # Get info by supplying extract object: get_extract_info(submitted_extract) # Get info by supplying the data collection and extract number, as a string: get_extract_info("usa:1") # Note that there is no space before or after the colon, and no zero-padding # of the extract number. # Get info by supplying the data collection and extract number, as a vector: get_extract_info(c("usa", "1")) }