ds.assign: Assigns an R object to a name in the server-side

In datashield/dsBaseClient: DataSHIELD Client Functions

Assigns an R object to a name in the server-side

Description

This function assigns a datashield object to a name, hence creating a new object.

Usage

ds.assign(toAssign = NULL, newobj = NULL, datasources = NULL)

Arguments

toAssign	a character string providing the object to assign.
newobj	a character string that provides the name for the output object that is stored on the data servers. Default assign.newobj.
datasources	a list of DSConnection-class objects obtained after login. If the datasources argument is not specified the default set of connections will be used: see datashield.connections_default.

Details

The new object is stored on the server-side.

ds.assign causes a remote assignment by using DSI::datashield.assign. The toAssign argument is checked at the server and assigned the variable called newobj on the server-side.

Value

ds.assign returns the R object assigned to a name that is written to the server-side.

Author(s)

DataSHIELD Development Team

Examples

## Not run: 
  ## Version 6, for version 5 see the Wiki
  
  # connecting to the Opal servers

  require('DSI')
  require('DSOpal')
  require('dsBaseClient')

  builder <- DSI::newDSLoginBuilder()
  builder$append(server = "study1", 
                 url = "http://192.168.56.100:8080/", 
                 user = "administrator", password = "datashield_test&", 
                 table = "CNSIM.CNSIM1", driver = "OpalDriver")
  builder$append(server = "study2", 
                 url = "http://192.168.56.100:8080/", 
                 user = "administrator", password = "datashield_test&", 
                 table = "CNSIM.CNSIM2", driver = "OpalDriver")
  builder$append(server = "study3",
                 url = "http://192.168.56.100:8080/", 
                 user = "administrator", password = "datashield_test&", 
                 table = "CNSIM.CNSIM3", driver = "OpalDriver")
  logindata <- builder$build()
  
  connections <- DSI::datashield.login(logins = logindata, assign = TRUE, symbol = "D") 
  
  # Assign a variable to a name
  ds.assign(toAssign = "D$LAB_TSC",
            newobj = "labtsc",
            datasources = connections[1]) #only the first Opal server is used ("study1")
                
  # Clear the Datashield R sessions and logout                 
  datashield.logout(connections) 
  

## End(Not run)   

datashield/dsBaseClient documentation built on May 16, 2023, 10:19 p.m.