opal.project_restore: Restore a project

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

Restore a project

Description

Restore the data of a project from a backup archive file to be found on the Opal file system. The destination project must exist and can have a name different from the original one (beware that this could break views). Default behavior is to stop when an item to restore already exist (override can be forced).

Usage

opal.project_restore(
  opal,
  project,
  archive,
  key = NULL,
  override = TRUE,
  wait = TRUE
)

Arguments

opal	Opal object.
project	Name of the project.
archive	Archive directory or zip file path in the Opal file system.
key	Archive zip file password (if applies).
override	Overwrite existing items (table, view, resource, report). Project files override is not checked. Default is TRUE.
wait	Wait for restore task completion. Default is TRUE.

Value

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

Examples

## Not run: 
o <- opal.login('administrator','password', url='https://opal-demo.obiba.org')
# create the project to restore, with the default database (to store tables)
opal.project_create(o, 'GREENSPACE2', database = TRUE)
# upload backup zip and launch restore task
opal.file_upload(o, 'GREENSPACE.zip', '/home/administrator')
opal.project_restore(o, 'GREENSPACE2', '/home/administrator/GREENSPACE.zip')
opal.logout(o)

## End(Not run)

opalr documentation built on Oct. 6, 2023, 5:08 p.m.