opal.login: Opal login

Description Usage Arguments Value Examples

Description

Log in Opal(s).

Usage

1
2
3
opal.login(username = getOption("opal.username"),
  password = getOption("opal.password"), url = getOption("opal.url"),
  opts = getOption("opal.opts", list()), restore = NULL)

Arguments

username

User name in opal(s). Can be provided by "opal.username" option.

password

User password in opal(s). Can be provided by "opal.password" option.

url

Opal url or list of opal urls. Can be provided by "opal.url" option.

opts

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

restore

Workspace ID to be restored (see also opal.logout)

Value

A opal object or a list of opal objects.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
## Not run: 

#### The below examples illustrate the different ways to login in opal ####

# explicite username/password login
o <- opal.login(username='administrator',password='password',url='https://opal-demo.obiba.org')

# login using options
options(opal.username='administrator',
 opal.password='password',
 opal.url='https://opal-demo.obiba.org')
o <- opal.login()

# login using ssl key pair
options(opal.opts=list(
   sslcert='my-publickey.pem',
   sslkey='my-privatekey.pem'))
o <- opal.login(url='https://opal-demo.obiba.org')

## End(Not run)

datashield/opal documentation built on May 14, 2019, 7:53 p.m.