databraryr (version 0.6.6)

login_db: Log In To Databrary.org.

Description

Log In To Databrary.org.

Usage

login_db(
  email = NULL,
  password = NULL,
  store = FALSE,
  overwrite = FALSE,
  vb = options::opt("vb"),
  SERVICE = KEYRING_SERVICE,
  rq = NULL
)

Value

Logical value indicating whether log in is successful or not.

Arguments

email

Databrary account email address.

password

Databrary password (not recommended as it will displayed as you type)

store

A boolean value. If TRUE store/retrieve credentials from the system keyring/keychain.

overwrite

A boolean value. If TRUE and store is TRUE, overwrite/ update stored credentials in keyring/keychain.

vb

Show verbose messages. (Defaults to FALSE, overwritable using option 'databraryr.vb' or environment variable 'R_DATABRARYR_VB')

SERVICE

A character label for stored credentials in the keyring. Default is "databrary"

rq

An http request object. Defaults to NULL.

Examples

if (FALSE) { # interactive()
login_db() # Queries user for email and password interactively.
}
# \donttest{
if (FALSE) {
# The following shows how to use credentials that have been stored previously.

login_db(email = "[e-mail]", store = TRUE)

}
# }