api_key_setup: Guide a new user at setting up a Census API key

In higherX4Racine/hercacstables: Work with American Community Survey Tables through the US Census API

Guide a new user at setting up a Census API key

Description

This only works in interactive mode. It checks if a key already exists in the environment. The key corresponds to Sys.getenv("CENSUS_API_KEY") in order to be compatible with the tidycensus package. If the key doesn't exist then it prompts you to either go to the Census website (it will open a browser window for you) or to enter in your API key (by typing or pasting). It then sets the value in your current environment and saves it to the .Renviron file in the user's HOME directory.

Usage

api_key_setup()

Value

a numeric status: 0 for success, 1 for quitting, 2 if the key exists.

See Also

tidycensus::census_api_key()

Examples

api_key_setup()

higherX4Racine/hercacstables documentation built on Jan. 15, 2025, 9:58 p.m.