dot-datashield.assign.table: Table data assignment

.datashield.assign.tableR Documentation

Table data assignment

Description

Assign a Opal value to a R symbol in the current Datashield session. This operation is asynchronous and non blocking.

Usage

.datashield.assign.table(
  opal,
  symbol,
  value,
  variables = NULL,
  missings = FALSE,
  identifiers = NULL,
  id.name = NULL,
  tibble = FALSE,
  async = TRUE
)

Arguments

opal

Opal object.

symbol

Name of the R symbol.

value

Fully qualified name of a variable or 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.

tibble

Assign table to a tibble (from tidyverse) instead of a plain data.frame.

async

Whether the call should be asynchronous.

Value

The R command ID if the async flag is TRUE and if the wait flag is FALSE and if Opal version is at least 2.1, NULL otherwise.


datashield/DSOpal documentation built on Oct. 11, 2022, 2:49 a.m.