aqs_credentials {RAQSAPI} | R Documentation |
aqs_credentials
Description
Sets the user credentials for the AQS API. This function
needs to be called once and only once every time this library
is re-loaded. Users must have a valid username and key which
can be obtained through the use of the aqs_sign_up function,
@seealso
aqs_sign_up()
to sign up for AQS data mart
credentials.
Usage
aqs_credentials(username = NA_character_, key = NA_character_)
Arguments
username |
a R character object which represents the email account that will be used to connect to the AQS API. |
key |
the key used in conjunction with the username given to connect to AQS Data Mart. |
Value
None
RAQSAPI setup functions
NA
Examples
#to authenticate an existing user the email address
# "John.Doe@myemail.com" and key = "MyKey"
# after calling this function please follow the instructions that are sent
# in the verification e-mail before proceeding.
## Not run: aqs_credentials(username = "John.Doe@myemail.com",
key = "MyKey")
## End(Not run)
[Package RAQSAPI version 2.0.5 Index]