PurpleAir (version 1.1.0)

check_api_key: Check Purple Air API Key

Description

Use the PurpleAir API to validate your Purple Air API Key. Find more details on this function at https://api.purpleair.com/#api-keys-check-api-key. Storing your key in the environment variable PURPLE_AIR_API_KEY is safer than storing it in source code and is used by default in each PurpleAir function.

Usage

check_api_key(purple_air_api_key = Sys.getenv("PURPLE_AIR_API_KEY"))

Value

If the key is valid, a message is emitted and the input is invisibly returned; invalid keys will throw an R error which utilizes information from the underlying http error to inform the user.

Arguments

purple_air_api_key

A character that is your PurpleAir API READ key

See Also

get_organization_data

Examples

if (FALSE) {
check_api_key()
try(check_api_key("foofy"))
}