dsConnect-ArmadilloDriver-method: Connect to an Armadillo DataSHIELD service

dsConnect,ArmadilloDriver-methodR Documentation

Connect to an Armadillo DataSHIELD service

Description

Connect to an Armadillo DataSHIELD service, with provided credentials.

Usage

## S4 method for signature 'ArmadilloDriver'
dsConnect(
  drv,
  name,
  restore = NULL,
  username = "",
  password = "",
  token = "",
  url,
  profile = "default",
  opts = list(),
  ...
)

Arguments

drv

ArmadilloDriver-class class object.

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

The username to authenticate with.

password

The password to authenticate with.

token

The ID token to authenticate with.

url

URL of the server.

profile

the profile to select, default "default"

opts

Curl options as described by httr (call httr::httr_options() for details). Can be provided by "Armadillo.opts" option.

...

Unused, needed for compatibility with generic.

Value

A ArmadilloConnection-class object.


DSMolgenisArmadillo documentation built on Nov. 2, 2023, 6:27 p.m.