Page Comparison

...

Login Log in Dataframe

...

The login dataframe is an R object that is created to store all of the login information necessary to access a DataSHIELD server, and save it for future logins, without having to gather the information each time. It is done by using a dedicated DataSHIELD function in the DSI package. It is then assigned to a local object, in the case below called "logindata", to be passed into the function for logging in to servers.

builder <- DSI::newDSLoginBuilder()
builder$append(server = "study1server1",  url = "http://192.168.56.100:8080/",
               user = "administrator", password = "datashield_test&",                table = "CNSIM.CNSIM1", driver = "OpalDriver")
builder$append(server = "study2server2", url = "http://192.168.56.101:8080/",
               user = "administrator", password = "datashield_test&",
               table = "CNSIM.CNSIM2", driver = "OpalDriver")

logindata <- builder$build()

Log

...

in Command

• Assign to a local object called "connections" the DSI function to log into in to the desired Opal servers. In the DataSHIELD test environment logindata is our login dataframe for the Opal training servers.

connections <- DSI::datashield.login(logins = logindata, assign = TRUE, symbol = "D")

• The output below indicates that each of the two Opal training servers dstutorial-100 and dstutorial-101 contain the same 11 variables listed in capital letters under Variables assigned:

Logging into the collaborating servers
  Logged in all servers [================================================================] 100% /14s

  No variables have been specified. 
  All the variables in the table 
  (the whole dataset) will be assigned to R!

Assigning table data...
  Assigned all tables [==================================================================] 100% /13s

Variables assigned:
study1 -- LAB_TSC, LAB_TRIG, LAB_HDL, LAB_GLUC_ADJUSTED, PM_BMI_CONTINUOUS, DIS_CVA, MEDI_LPD, DIS_DIAB, DIS_AMI, GENDER, PM_BMI_CATEGORICAL
study2 -- LAB_TSC, LAB_TRIG, LAB_HDL, LAB_GLUC_ADJUSTED, PM_BMI_CONTINUOUS, DIS_CVA, MEDI_LPD, DIS_DIAB, DIS_AMI, GENDER, PM_BMI_CATEGORICAL

• Command to logout:

DSI::datashield.logout(connections)

24s

Assign tables command

Finally, after successfully making a connection with the server, you must specify which studies, stored in tables, you wish to connect to. This is done with another of the DSI package functions, "datashield.assign.table". 

DSI::datashield.assign.table(conns = connections, symbol = "DST", table = c("CNSIM.CNSIM1","CNSIM.CNSIM2"))

• The "conns" argument is to create a name for a DSConnection-class object, which will be used by statistical commands to refer to particular studies.
• The "symbol" argument is to create a name by which to refer to the dataframes in each study. Here we have opted for "DST" , an initialism for "DataSHIELD Table" 

• the "table" argument is to specify the names of the tables you wish to connect to as they appear on the server you are on. The structure, "AAAA.BBBB", "AAAA.CCCC" means that within project AAAA there are tables BBBB and CCCC which we connect to both of, by listing them in an R vector.

An example of the printout after the login process has finished:

Assigned all table (DST <- ...) [======================================================] 100% /25s

Command to logout:

You should get into the habit of putting this command at the end of your scripts, and running it after you are finished. It is particularly important to do so when connecting to shared DataSHIELD servers, to save resources for the analyses of others.

DSI::datashield.logout(connections)

In a later tutorial in this series, you will find the option of saving your workspace before logging out, to be able to log in another day and have all your variables intact and ready to go without having to run everything again!

...

The other parts in this DataSHIELD tutorial series are:

• 1: Introduction and logging in

• 2: Basic statistics and data manipulations

• 3: Assign functions and tables

• 4: Plotting graphs

• 5:  Subsetting

• 6: Modelling

...