create_user: Create user-key object for accessing AQS API
In jpkeller/aqsr: Interface to EPA AQS

Description Usage Arguments Details Value See Also

View source: R/aqs_user.R

Create user-key object for accessing AQS API

1
2
3

create_user(email, key)

aqs_signup(email, ...)

`email`	Email address of user
`key`	Key phrase of user
`...`	Additional arguments passed to `aqs_get`

The AQS API requires an email address and key for all queries. The key is not used for authentication (as in a password), but it is used for identification.

Once established, the email and key can be stored as environment variables as AQS_EMAIL and AQS_KEY, respectively. Calling create_user without any argument will then read from these values. Care should still be taken to avoid storing the resulting object in a public repository.

Use aqs_signup to register an email and obtain a key phrase. The key value is emailed to the provided address, it is not return directly from the API.

create_user returns a list containing the email and key.

aqs_get

jpkeller/aqsr documentation built on Aug. 15, 2021, 5:32 p.m.