opalr (version 3.3.1)

opal.symbol_import: Import a tibble

Description

Import a tibble identified by the symbol as a table in Opal. This operation creates an importation task in Opal that can be followed (see tasks related functions).

Usage

opal.symbol_import(
  opal,
  symbol,
  project,
  identifiers = NULL,
  policy = "required",
  id.name = "id",
  type = "Participant",
  wait = TRUE
)

Arguments

opal

Opal object.

symbol

Name of the R symbol representing a tibble.

project

Name of the project into which the data are to be imported.

identifiers

Name of the identifiers mapping to use when assigning entities to Opal.

policy

Identifiers policy: 'required' (each identifiers must be mapped prior importation (default)), 'ignore' (ignore unknown identifiers) and 'generate' (generate a system identifier for each unknown identifier).

id.name

The name of the column representing the entity identifiers. Default is 'id'.

type

Entity type (what the data are about). Default is 'Participant'.

wait

Wait for import task completion. Default is TRUE.

See Also

Other symbol functions: opal.rm(), opal.symbol_rm(), opal.symbol_save(), opal.symbols()

Examples

if (FALSE) {
o <- opal.login('administrator','password', url='https://opal-demo.obiba.org')
opal.symbol_import(o, 'D', 'test')
opal.logout(o)
}