Download an IPUMS data extract via the IPUMS API. For an overview of ipumsr
API functionality, see vignette("ipums-api", package = "ipumsr").
download_extract( extract, download_dir = getwd(), overwrite = FALSE, api_key = Sys.getenv("IPUMS_API_KEY") )
| extract | One of:
The extract number does not need to be zero-padded (e.g., use |
|---|---|
| download_dir | In what folder should the downloaded files be saved? Defaults to current working directory. |
| overwrite | Logical indicating whether to overwrite files that already
exist. Defaults to |
| api_key | API key associated with your user account. Defaults to the value of environment variable "IPUMS_API_KEY". |
Invisibly, the path to the downloaded .xml DDI file.
Other ipums_api:
define_extract_from_json(),
define_extract_micro(),
extract_list_to_tbl(),
extract_tbl_to_list(),
get_extract_info(),
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) # Download extract by supplying extract object: path_to_ddi_file <- download_extract(submitted_extract) # By supplying the data collection and extract number, as a string: path_to_ddi_file <- download_extract("usa:1") # Note that there is no space before or after the colon, and no zero-padding # of the extract number. # By supplying the data collection and extract number, as a vector: path_to_ddi_file <- download_extract(c("usa", "1")) }