set_ipums_api_key

Set your IPUMS API key as the value associated with the <code>IPUMS_API_KEY</code>
environment variable.
The key can be stored for the duration of your session or for future
sessions. If saved for future sessions, it is added to the <code>.Renviron</code>
file in your home directory. If you choose to save your key to <code>.Renviron</code>,
this function will create a backup copy of the file before modifying.
This function is modeled after the <code>census_api_key()</code> function
from <a href="https://walker-data.com/tidycensus/">tidycensus</a>.
Learn more about the IPUMS API in <code>vignette("ipums-api")</code>.

An easy way to work with census, survey, and geographic data
provided by IPUMS in R. Generate and download data through the IPUMS
API and load IPUMS files into R with their associated metadata to
make analysis easier. IPUMS data describing 1.4 billion individuals
drawn from over 750 censuses and surveys is available free of charge
from the IPUMS website <https://www.ipums.org>.

Derek Burk 

ipumsr

An R Interface for Downloading, Reading, and Handling IPUMS Data

Greg Freedman Ellis 

Finn Roberts 

Joe Grover 

Dan Ehrlich 

Renae Rodgers 

Institute for Social Research and Data Innovation 

set_ipums_api_key function

<dl><dt>api_key</dt>
<dd>API key associated with your user account.</dd>
<dt>save</dt>
<dd>If <code>TRUE</code>, save the key for use in future
sessions by adding it to the <code>.Renviron</code> file in your home directory.
Defaults to <code>FALSE</code>, unless <code>overwrite = TRUE</code>.</dd>
<dt>overwrite</dt>
<dd>If <code>TRUE</code>, overwrite any existing value of
<code>IPUMS_API_KEY</code> in the <code>.Renviron</code> file with the provided <code>api_key</code>.
Defaults to <code>FALSE</code>.</dd>
<dt>unset</dt>
<dd>If <code>TRUE</code>, remove the existing value of <code>IPUMS_API_KEY</code>
from the environment and the <code>.Renviron</code> file in your home directory.</dd></dl>

Arguments

Set your IPUMS API key as the value associated with the <code>IPUMS_API_KEY</code>
environment variable.
The key can be stored for the duration of your session or for future
sessions. If saved for future sessions, it is added to the <code>.Renviron</code>
file in your home directory. If you choose to save your key to <code>.Renviron</code>,
this function will create a backup copy of the file before modifying.
This function is modeled after the <code>census_api_key()</code> function
from <a href='https://walker-data.com/tidycensus/'>tidycensus</a>.
Learn more about the IPUMS API in <code>vignette("ipums-api")</code>.

Set your IPUMS API key — set_ipums_api_key

<dl>

<dt>api_key</dt>
<dd>API key associated with your user account.</dd>


<dt>save</dt>
<dd>If <code>TRUE</code>, save the key for use in future
sessions by adding it to the <code>.Renviron</code> file in your home directory.
Defaults to <code>FALSE</code>, unless <code>overwrite = TRUE</code>.</dd>


<dt>overwrite</dt>
<dd>If <code>TRUE</code>, overwrite any existing value of
<code>IPUMS_API_KEY</code> in the <code>.Renviron</code> file with the provided <code>api_key</code>.
Defaults to <code>FALSE</code>.</dd>


<dt>unset</dt>
<dd>If <code>TRUE</code>, remove the existing value of <code>IPUMS_API_KEY</code>
from the environment and the <code>.Renviron</code> file in your home directory.</dd>

</dl>

set_ipums_api_key: Set your IPUMS API key

Description

Usage

Value

Arguments

See Also