opalr (version 3.3.1)

opal.project_backup: Backup a project

Description

The project backup task has a limited scope: tables (dictionary and data export), views (either as a logical table or as an exported table), resources, files and report templates. Other project elements that are not part of the backup: user and group permissions, view change history, table analysis, report executions etc.

Usage

opal.project_backup(
  opal,
  project,
  archive,
  viewsAsTables = FALSE,
  override = TRUE,
  wait = TRUE
)

Value

The project command ID if wait parameter is FALSE. See opal.project_command to retrieve asynchronous command state.

Arguments

opal

Opal object.

project

Name of the project.

archive

Archive directory path in the Opal file system. If folder (and parents) does not exist, it will be created.

viewsAsTables

Treat views as tables, i.e. export data instead of keeping derivation scripts. Default is FALSE.

override

Overwrite an existing backup folder. Default is TRUE.

wait

Wait for backup task completion. Default is TRUE.

Examples

if (FALSE) {
o <- opal.login('administrator','password', url='https://opal-demo.obiba.org')
opal.project_backup(o, 'GREENSPACE', '/home/administrator/backup/GREENSPACE')
opal.file_download(o, '/home/administrator/backup/GREENSPACE', 'GREENSPACE.zip')
opal.logout(o)
}