DSI (version 1.7.0)

DSObject-class: DSObject class

Description

Base class for all other DataSHIELD classes (e.g., drivers, connections). This is a virtual Class: No objects may be created from it.

Implementation notes

An implementation MUST provide methods for the following generics:

• dsGetInfo

It MAY also provide methods for:

• summary Print a concise description of the object. The default method invokes `dsGetInfo(dsObj)` and prints the name-value pairs one per line. Individual implementations may tailor this appropriately.

Details

More generally, DataSHIELD defines a very small set of classes and generics that allows users and applications perform meta-analysis with a common interface. The virtual classes are `DSDriver` that individual drivers extend, `DSConnection` that represent instances of DataSHIELD-aware data repository connections, and `DSResult` that represent the result of a DataSHIELD operation. These three classes extend the basic class of `DSObject`, which serves as the root or parent of the class hierarchy.

See Also

Other DS classes: DSConnection-class, DSDriver-class, DSResult-class

Examples

if (FALSE) {
drv <- DSOpal::Opal()
con <- dsConnect(drv, 
  username = "dsuser", password = "password", url = "https://opal-demo.obiba.org")

rs <- dsAssign(con, "Project.TableA")
is(drv, "DSObject")  ## True
is(con, "DSObject")  ## True
is(rs, "DSObject")   ## True

dsDisconnect(con)
}