set_login: Login helper function

Description Usage Arguments Details Functions Examples

View source: R/set_login.R

Description

Set and forget the user name and the password to be connected to the Traitbase API.

Usage

1
2
3
4
5
set_login(user = NULL, pwd = NULL)

forget_login()

get_login(user = NULL, pwd = NULL)

Arguments

user

a character string containing the user name.

pwd

a character string containing the password name.

Details

set_login() sets the environmental variables TRAITBASE_USER, TRAITBASE_PWD for the current R session. Note that if you want to set then permanently, you can add them in .Renviron, or your .Rprofile (see Startup). set_login() retrieves TRAITBASE_USER, TRAITBASE_PWD and calls set_login() if not set.

Functions

Examples

1
2
3
4
 # NB the password below is false.
 set_login(user = 'KevCaz', pwd = 'you')
 # interactively
 forget_login()

metadevpro/traitbaser documentation built on April 20, 2020, 10:52 p.m.