Assign a data table from the data repository to a symbol in the DataSHIELD R session. The table to be assigned must exist (i.e. proper permissions apply) for the DataSHIELD user.
dsAssignTable(
conn,
symbol,
table,
variables = NULL,
missings = FALSE,
identifiers = NULL,
id.name = NULL,
async = TRUE
)
An object that inherits from DSConnection-class
.
Name of the R symbol.
Fully qualified name of a table in the data repository.
List of variable names or Javascript expression that selects the variables of a table. See javascript documentation: http://opaldoc.obiba.org/en/latest/magma-user-guide/variable/
If TRUE, missing values will be pushed from data repository to R, default is FALSE.
Name of the identifiers mapping to use when assigning entities to R (if supported by the data repository).
Name of the column that will contain the entity identifiers. If not specified, the identifiers will be the data frame row names. When specified this column can be used to perform joins between data frames.
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.
Other DSConnection generics:
DSConnection-class
,
dsAggregate()
,
dsAssignExpr()
,
dsAssignResource()
,
dsDisconnect()
,
dsGetInfo()
,
dsHasResource()
,
dsHasTable()
,
dsIsAsync()
,
dsKeepAlive()
,
dsListMethods()
,
dsListPackages()
,
dsListProfiles()
,
dsListResources()
,
dsListSymbols()
,
dsListTables()
,
dsListWorkspaces()
,
dsRestoreWorkspace()
,
dsRmSymbol()
,
dsRmWorkspace()
,
dsSaveWorkspace()
if (FALSE) {
con <- dsConnect(DSOpal::Opal(), "server1",
username = "dsuser", password = "password", url = "https://opal-demo.obiba.org")
dsAssignTable(con, "D", "test.CNSIM")
dsDisconnect(con)
}