dsIsReady: Get whether the remote R session is up and running

In DSI: 'DataSHIELD' Interface

Get whether the remote R session is up and running

Description

Get whether the remote R session is up and running, ready to accept R commands. The primary use of this function is to know whether the session is ready after it has been created in an asynchronous way.

Usage

dsIsReady(session)

Arguments

session

An object inheriting from DSSession-class.

Value

A logical

See Also

Other DSSession generics: DSSession-class, dsStateMessage()

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(".")
}
dsDisconnect(con)

## End(Not run)

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