R/DataSHIELD remote sessions — datashield.sessions • DSI

Ensure that the remote R sessions are up and running during the analysis.

Usage

datashield.sessions(
  conns,
  async = TRUE,
  success = NULL,
  error = NULL,
  errors.print = getOption("datashield.errors.print", FALSE)
)

Arguments

conns: DSConnection-class object or a list of DSConnection-classs.
async: Whether the remote R/DataSHIELD session should be created asynchronously. When TRUE (default) the calls are parallelized over the connections, when the connection supports that feature, with an extra overhead of requests.
success: Callback function that will be called each time an R session has been created from a connection. The expected function signature is the connection/study name. Default is NULL (no callback).
error: Callback function that will be called each time the R session creation request has failed. The expected function signature is the connection/study name and the error message. Default is NULL (no callback).
errors.print: Boolean, whether to print datashield errors in the console or return a message indicating that they can be retrieved using `datashield.errors`.

Examples

if (FALSE) { # \dontrun{
# call sessions function on server side asynchronously
# i.e. each study connection will create a remote R session in parallel
datashield.sessions(conns)

# call sessions function with callback functions
result <- datashield.sessions(conns,
  success = function(server) {
    # do something with server's success
  },
  error = function(server, error) {
    # do something with server's error
  })
} # }