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

963

Version

1.5.0

License

LGPL (>= 2.1)

Issues

2

Pull Requests

0

Stars

0

Forks

1

Maintainer

Yannick Marcon

Last Published

November 5th, 2025

Functions in DSOpal (1.5.0)

.datashield.symbols

List R symbols
dsAggregate,OpalConnection-method

Aggregate data
dsAssignExpr,OpalConnection-method

Assign the result of an expression
.datashield.workspace_rm

Remove a DataSHIELD workspace from a opal.
dsAssignResource,OpalConnection-method

Assign a resource
dsAssignTable,OpalConnection-method

Assign a table
.datashield.commands_rm

Remove all asynchronous commands
.deparse

Turn expression into character strings.
.datashield.methods

List Datashield methods
dsIsAsync,OpalConnection-method

Opal asynchronous support
.datashield.workspaces

Get the DataSHIELD workspaces.
dsHasTable,OpalConnection-method

Verify Opal table
.newDatashieldSession

Create a new Datashield R session in Opal.
.rmDatashieldSession

Remove a Datashield R session in Opal.
dsFetch,OpalResult-method

Fetch the result
dsListPackages,OpalConnection-method

List packages
dsListProfiles,OpalConnection-method

List profiles
.getPEMFilePath

Extract absolute path to the pem file
.datashield.workspace_restore

Restore a saved workspace in the current DataSHIELD session.
.getDatashieldSessionId

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

Get whether the operation is completed
dsRmWorkspace,OpalConnection-method

Remove a workspace
logindata.opal.demo

DataSHIELD login data file
dsGetInfo,OpalResult-method

Get result info
dsListMethods,OpalConnection-method

List methods
dsKeepAlive,OpalConnection-method

Keep connection with a Opal server alive
.datashield.workspace_save

Save current session in a DataSHIELD workspace.
dsConnect,OpalDriver-method

Connect to a Opal server
dsSession,OpalConnection-method

Create a remote R session
dsListWorkspaces,OpalConnection-method

List workspaces
dsDisconnect,OpalConnection-method

Disconnect from a Opal server
dsListTables,OpalConnection-method

List Opal tables
dsHasSession,OpalConnection-method

Check remote R session exists
dsListSymbols,OpalConnection-method

List R symbols
dsHasResource,OpalConnection-method

Verify Opal resource
dsListResources,OpalConnection-method

List Opal resources
dsStateMessage,OpalSession-method

Get the remote R session state message
dsRmSymbol,OpalConnection-method

Remove a R symbol
dsRestoreWorkspace,OpalConnection-method

Restore workspace
dsIsReady,OpalSession-method

Get whether the remote R session is up and running
dsSaveWorkspace,OpalConnection-method

Save workspace
DSOpal-package

DSOpal: 'DataSHIELD' Implementation for 'Opal'
Opal

Create a Opal driver
OpalResult-class

Class OpalResult.
.datashield.assign.table

Table data assignment
.datashield.assign.resource

Resource data assignment
.datashield.commands

List the asynchronous commands
.datashield.profiles

List Datashield profiles
OpalConnection-class

Class OpalConnection.
.datashield.rm

Remove a R symbol
OpalDriver-class

Class OpalDriver with constructor Opal.
.datashield.assign.expr

Data assignment
.datashield.command_rm

Remove an asynchronous command
OpalSession-class

Class OpalSession.
.datashield.aggregate

Data aggregation
.datashield.command

Get an asynchronous command
.datashield.command_result

Get result of an asynchronous command