aur_register: Create an AURIN authentication file.

In aurin: Access Datasets from the 'AURIN' API

Description

This function writes your AURIN API authentication as a R environment variable of your current session. If add_to_renviron is TRUE, it will write the API to your .Renviron file as AURIN_API_USERPWD.

Usage

aur_register(username, password, add_to_renviron = FALSE, overwrite = FALSE)

Arguments

username	Character. AURIN API username.
password	Character. AURIN API password.
add_to_renviron	Logical. Default is FALSE. If TRUE then the file directory of the authentication file will be added to your .Renviron file.
overwrite	Logical. Default is FALSE. If TRUE, the existing AURIN_API_USERPWD R environment variable will be replaced with new username and password.

Examples

## Not run: 
aur_register("username", "password")

## End(Not run)

aurin documentation built on Feb. 1, 2022, 1:06 a.m.