dsStateMessage: Get the state of the remote R session

In DSI: 'DataSHIELD' Interface

Get the state of the remote R session

Description

Get a human-readable message that informs about the state of the remote R session. The primary use of this function is to inform the user about the session state process after it has been created in an asynchronous way.

Usage

dsStateMessage(session)

Arguments

session

An object inheriting from DSSession-class.

Value

A character string

See Also

Other DSSession generics: DSSession-class, dsIsReady()

Examples

## Not run: 
con <- dsConnect(DSOpal::Opal(), "server1",
  username = "dsuser", password = "password", url = "https://opal-demo.obiba.org")
session <- dsSession(con, async = TRUE)
ready <- dsIsReady(session)
while (!ready) {
  Sys.sleep(1)
  ready <- dsIsReady(session)
  cat(dsStateMessage(session), "\n")
}
dsDisconnect(con)

## End(Not run)

DSI documentation built on Nov. 5, 2025, 6:27 p.m.