amberr (version 1.2.0)

amber.login: Opan a connection with Amber

Description

Open a connection with Amber and returns an Amber object. When the two-factor authentication mechanism is enabled, the user will be prompt for one-time password input.

Usage

amber.login(
  username = getOption("amber.username", "anonymous"),
  password = getOption("amber.password", "password"),
  url = getOption("amber.url"),
  opts = getOption("amber.opts", list())
)

Value

An Amber object

An amber connection object to be used in further function calls

Arguments

username

User name in Amber. Can be provided by "amber.username" option.

password

User password in Amber. Can be provided by "amber.password" option.

url

Amber url. Can be provided by "amber.url" option. Secure http (https) connection is required.

opts

Curl options. Can be provided by "amber.opts" option.

Examples

if (FALSE) {
# login using credentials from amber.username and amber.password options
a <- amber.login("https://amber-demo.obiba.org")
# login by providing credentials
a <- amber.login("administrator", "password", "https://amber-demo.obiba.org")
}