dsConnect,OpalDriver-method {DSOpal} | R Documentation |
Connect to a Opal server
Description
Connect to a Opal server, with provided credentials. Does not create a DataSHIELD R session, only retrieves user profile.
Usage
## S4 method for signature 'OpalDriver'
dsConnect(
drv,
name,
restore = NULL,
username = NULL,
password = NULL,
token = NULL,
url = NULL,
opts = list(),
profile = NULL,
...
)
Arguments
drv |
|
name |
Name of the connection, which must be unique among all the DataSHIELD connections. |
restore |
Workspace name to be restored in the newly created DataSHIELD R session. |
username |
User name in opal(s). |
password |
User password in opal(s). |
token |
Personal access token (since opal 2.15, ignored if username is specified). |
url |
Opal url or list of opal urls. Can be provided by "opal.url" option. |
opts |
Curl options as described by httr (call httr::httr_options() for details). Can be provided by "opal.opts" option. |
profile |
The DataSHIELD R server profile (affects the R packages available and the applied configuration). If not provided or not supported, default profile will be applied. |
... |
Unused, needed for compatibility with generic. |
Value
A OpalConnection-class
object.
Examples
## Not run:
con <- dsConnect(DSOpal::Opal(), "server1", "username", "password", "https://opal.example.org")
con
dsDisconnect(con)
## End(Not run)