Skip to contents

Get or Set Up API Key for TERN

Source: R/get_key.R
get_key.Rd

Checks first to get key from your .Rprofile or .Renviron (or similar) file. If it's not found, then it suggests setting it up. Can be used to check that your key that R is using is the key that you wish to be using or for guidance in setting up the keys.

Usage

get_key()

Value

A string value with your API key value.

Requesting an API Key

To request an API key, go to https://account.tern.org.au/authenticated_user/apikeys and click on "Sign In" in the upper right corner. Sign in with your proper credentials. Then, from the left-hand menu, click on "Create API Key". Once this is done, copy the key and put it in your .Renviron using usethis::edit_r_environ() as TERN_API_KEY="your_api_key". Restart your R session and the query should work.

Examples

if (FALSE) { # \dontrun{
get_key()
} # }