Assign a table — dsAssignTable,OpalConnection-method • DSOpal

Assign a Opal table in the DataSHIELD R session.

# S4 method for OpalConnection
dsAssignTable(
  conn,
  symbol,
  table,
  variables = NULL,
  missings = FALSE,
  identifiers = NULL,
  id.name = NULL,
  async = TRUE
)

Arguments

conn: OpalConnection-class object.
symbol: Name of the R symbol.
table: Fully qualified name of a table in Opal.
variables: List of variable names or Javascript expression that selects the variables of a table (ignored if value does not refere to a table). See javascript documentation: https://opaldoc.obiba.org/en/latest/magma-user-guide/methods.html
missings: If TRUE, missing values will be pushed from Opal to R, default is FALSE. Ignored if value is an R expression.
identifiers: Name of the identifiers mapping to use when assigning entities to R (from Opal 2.0).
id.name: 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.
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.

Value

A OpalResult-class object.

Examples

if (FALSE) {
con <- dbConnect(DSOpal::Opal(), "server1",
  "username", "password", "https://opal.example.org")
dsAssignTable(con, "D", "test.CNSIM")
dsDisconnect(con)
}