opal.table_get: Get a Opal table as a tibble

In opalr: 'Opal' Data Repository Client and 'DataSHIELD' Utils

Get a Opal table as a tibble

Description

Shortcut function to assign a Opal table to a tibble in the R server-side session and then retrieve it into the R client-side session. Requires to have the permission to see the individual values of the table and to perform R assignments.

Usage

opal.table_get(
  opal,
  project,
  table,
  id.name = "id",
  variables = NULL,
  missings = TRUE
)

Arguments

opal	Opal connection object.
project	Project name where the table is located.
table	Table name from which the tibble should be extracted.
id.name	The name of the column representing the entity identifiers. Default is 'id'. Requires Opal 4.0+.
variables	(Deprecated) List of variable names or Javascript expression that selects the variables of a table (ignored if value does not refer to a table). See javascript documentation: http://wiki.obiba.org/display/OPALDOC/Variable+Methods
missings	(Deprecated) Include the missing values (default is TRUE).

See Also

Other table functions: opal.perms(), opal.resource_view_create(), opal.resource_view_reconnect(), opal.table_create(), opal.table_delete(), opal.table_dictionary_get(), opal.table_dictionary_update(), opal.table_exists(), opal.table_export(), opal.table_import(), opal.table_perm(), opal.table_perm_add(), opal.table_perm_delete(), opal.table_save(), opal.table_truncate(), opal.table_view_create(), opal.table_view_update()

Examples

## Not run: 
o <- opal.login('administrator','password', url='https://opal-demo.obiba.org')
cqx <- opal.table_get(o, "CPTP", "Cag_coreqx")
opal.logout(o)

## End(Not run)

opalr documentation built on Sept. 18, 2024, 9:11 a.m.