dsAssignResource: Assign a resource object

In DSI: 'DataSHIELD' Interface

Assign a resource object

Description

Assign a resource object of class 'ResourceClient' from the data repository to a symbol in the DataSHIELD R session. The resource reference to be assigned must exist (i.e. proper permissions apply) for the DataSHIELD user.

\Sexpr[results=rd,stage=render]{DSI:::methods_as_rd("dsAssignResource")}

Usage

dsAssignResource(conn, symbol, resource, async = TRUE)

Arguments

conn	An object that inherits from DSConnection-class.
symbol	Name of the R symbol.
resource	Fully qualified name of a resource reference in the data repository.
async	Whether the result of the call should be retrieved asynchronously. When TRUE (default) the calls are parallelized over the connections, when the connection supports that feature, with an extra overhead of requests.

See Also

Other DSConnection generics: DSConnection-class, dsAggregate(), dsAssignExpr(), dsAssignTable(), dsDisconnect(), dsGetInfo(), dsHasResource(), dsHasTable(), dsIsAsync(), dsKeepAlive(), dsListMethods(), dsListPackages(), dsListProfiles(), dsListResources(), dsListSymbols(), dsListTables(), dsListWorkspaces(), dsRestoreWorkspace(), dsRmSymbol(), dsRmWorkspace(), dsSaveWorkspace()

Examples

## Not run: 
con <- dsConnect(DSOpal::Opal(), "server1",
  username = "dsuser", password = "password", url = "https://opal-demo.obiba.org")
dsAssignResource(con, "D", "test.CNSIM")
dsDisconnect(con)

## End(Not run)

DSI documentation built on Oct. 6, 2022, 9:06 a.m.