Set your IPUMS API key for the duration of your session, or indefinitely by
adding it to the file ".Renviron" in your home directory. In either case,
this function works by assigning your API key as the value of the environment
variable IPUMS_API_KEY
. If you choose to save your key to ".Renviron", this
function will create a backup copy of the file before modifying. This
function is modeled after the census_api_key()
function
from the R package tidycensus.
set_ipums_api_key(api_key, save = FALSE, overwrite = FALSE)
The value of api_key
, invisibly.
API key associated with your user account, formatted in quotes.
Do you want to save this value for future sessions by adding it
to the file ".Renviron" in your home directory? Defaults to FALSE
.
Do you want to overwrite any existing value of
IPUMS_API_KEY
in the file ".Renviron"? Defaults to FALSE
.
Other ipums_api:
add_to_extract()
,
define_extract_cps()
,
define_extract_from_json()
,
define_extract_usa()
,
download_extract()
,
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()
,
remove_from_extract()
,
save_extract_as_json()
,
submit_extract()
,
wait_for_extract()