saveOpalTable: Save the tibble as a Opal table

Description Usage Arguments Value

View source: R/saveOpalTable.R

Description

Assign the tibble from the R client-side session to the R session-side session with the provided symbol name and import it into the Opal project. If variables dictionary is provided, it will be applied after the import.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
saveOpalTable(
  opal,
  tibble,
  project,
  table,
  overwrite = TRUE,
  force = FALSE,
  identifiers = NULL,
  policy = "required",
  id.name = "id",
  type = "Participant",
  variables = NULL,
  categories = NULL
)

Arguments

opal

Opal connection object.

tibble

The tibble object to be imported.

project

Project name where the table will be located.

table

Destination table name.

overwrite

If the destination table already exists, it will be replaced (deleted and then imported). Otherwise the table will be updated (data dictionaries merge may conflict). Default is TRUE.

force

If the destination already exists, stop with an informative message if this flag is FALSE (default).

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'

variables

A data frame with one row per variable (column name) and then one column per property/attribute (Opal Excel format).

categories

A data frame with one row per category (columns variable and name) and then column per property/attribute (Opal Excel format). If there are no categories, this parameter is optional.

Value

An invisible logical indicating whether the destination table exists.


maelstrom-research/harmor documentation built on Dec. 6, 2019, 7:31 p.m.