Learn R Programming

DataSHIELD Opal

DataSHIELD Interface (DSI) implementation for Opal data warehouse, based on Opal R Client (opalr) package.

This is the reference implementation of the DataSHIELD Interface that can be used for implementing other data repository clients supporting DataSHIELD infrastructure.

See usage examples.

Articles about Opal and DataSHIELD:

Copy Link

Version

Install

install.packages('DSOpal')

Monthly Downloads

533

Version

1.4.1

License

LGPL (>= 2.1)

Issues

2

Pull Requests

0

Stars

0

Forks

1

Maintainer

Yannick Marcon

Last Published

July 25th, 2025

Functions in DSOpal (1.4.1)

.datashield.command_rm

Remove an asynchronous command
.deparse

Turn expression into character strings.
.datashield.workspace_save

Save current session in a DataSHIELD workspace.
.datashield.symbols

List R symbols
.datashield.rm

Remove a R symbol
.getDatashieldSessionId

Extract R session Id from opal object, create a new Datashield R session if not found.
dsAssignTable,OpalConnection-method

Assign a table
dsListWorkspaces,OpalConnection-method

List workspaces
dsSaveWorkspace,OpalConnection-method

Save workspace
dsListTables,OpalConnection-method

List Opal tables
dsFetch,OpalResult-method

Fetch the result
dsAggregate,OpalConnection-method

Aggregate data
dsDisconnect,OpalConnection-method

Disconnect from a Opal server
dsListSymbols,OpalConnection-method

List R symbols
dsRestoreWorkspace,OpalConnection-method

Restore workspace
.datashield.commands

List the asynchronous commands
.rmDatashieldSession

Remove a Datashield R session in Opal.
.datashield.workspaces

Get the DataSHIELD workspaces.
logindata.opal.demo

DataSHIELD login data file
dsConnect,OpalDriver-method

Connect to a Opal server
dsKeepAlive,OpalConnection-method

Keep connection with a Opal server alive
dsIsCompleted,OpalResult-method

Get whether the operation is completed
.getPEMFilePath

Extract absolute path to the pem file
.newDatashieldSession

Create a new Datashield R session in Opal.
.datashield.commands_rm

Remove all asynchronous commands
dsGetInfo,OpalResult-method

Get result info
dsHasResource,OpalConnection-method

Verify Opal resource
dsListPackages,OpalConnection-method

List packages
dsListMethods,OpalConnection-method

List methods
dsAssignExpr,OpalConnection-method

Assign the result of an expression
dsHasTable,OpalConnection-method

Verify Opal table
dsListProfiles,OpalConnection-method

List profiles
dsRmSymbol,OpalConnection-method

Remove a R symbol
dsAssignResource,OpalConnection-method

Assign a resource
dsIsAsync,OpalConnection-method

Opal asynchronous support
dsRmWorkspace,OpalConnection-method

Remove a workspace
dsListResources,OpalConnection-method

List Opal resources
OpalResult-class

Class OpalResult.
Opal

Create a Opal driver
.datashield.command

Get an asynchronous command
.datashield.workspace_restore

Restore a saved workspace in the current DataSHIELD session.
.datashield.assign.resource

Resource data assignment
.datashield.aggregate

Data aggregation
OpalDriver-class

Class OpalDriver with constructor Opal.
.datashield.methods

List Datashield methods
DSOpal-package

DSOpal: 'DataSHIELD' Implementation for 'Opal'
.datashield.profiles

List Datashield profiles
.datashield.assign.table

Table data assignment
.datashield.workspace_rm

Remove a DataSHIELD workspace from a opal.
OpalConnection-class

Class OpalConnection.
.datashield.assign.expr

Data assignment
.datashield.command_result

Get result of an asynchronous command