set_aqs_user: Set your AQS API credentials
In raqs: Interface to the US EPA Air Quality System (AQS) API

set_aqs_user

R Documentation

Set your AQS API credentials

Description

Set your registered email and key as environmental variables for the current session. Please sign up first using aqs_signup if you haven't set up an account on the AQS API. If you want to set your email and key permanently, please add the following lines in your .Renviron file:

AQS_EMAIL = YOUR REGISTERED EMAIL
AQS_KEY = YOUR API KEY

Usage

set_aqs_user(email, key)

get_aqs_user()

get_aqs_email()

get_aqs_key()

Arguments

`email`	A string specifying your registered email address
`key`	A string specifying your API key

Details

set_aqs_user sets your API credentials for the current session. get_aqs_user, get_aqs_email, and get_aqs_key are helper functions to display saved user values.

Value

No return value, called to set environmental variables

Examples

## Please use your registered email and key
set_aqs_user(email = "your@registered.email", key = "your_api_key")

## Show your API credentials
get_aqs_user() # return list(email, key)
get_aqs_email() # return email
get_aqs_key() # return key

raqs documentation built on Nov. 21, 2023, 1:07 a.m.