-
Notifications
You must be signed in to change notification settings - Fork 24
/
ds.c.R
94 lines (85 loc) · 3.73 KB
/
ds.c.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
#'
#' @title Combines values into a vector or list in the server-side
#' @description Concatenates objects into one vector.
#' @details To avoid combining the character names and not the
#' vectors on the client-side, the names are coerced into a list
#' and the server-side function loops through that list to
#' concatenate the list's elements into a vector.
#'
#' Server function called: \code{cDS}
#' @param x a vector of character string providing the names of the objects to be combined.
#' @param newobj a character string that provides the name for the output object
#' that is stored on the data servers. Default \code{c.newobj}.
#' @param datasources a list of \code{\link{DSConnection-class}}
#' objects obtained after login. If the \code{datasources} argument is not specified
#' the default set of connections will be used: see \code{\link{datashield.connections_default}}.
#' @return \code{ds.c} returns the vector of concatenating R
#' objects which are written to the server-side.
#' @examples
#' \dontrun{
#' ## 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")
#'
#' # Create a vector with combined objects
#' myvect <- c("D$LAB_TSC", "D$LAB_HDL")
#' ds.c(x = myvect,
#' newobj = "new.vect",
#' datasources = connections[1]) #only the first Opal server is used ("study1")
#'
#' # Clear the Datashield R sessions and logout
#' datashield.logout(connections)
#'
#' }
#' @author DataSHIELD Development Team
#' @export
#'
ds.c <- function(x=NULL, newobj=NULL, datasources=NULL){
# look for DS connections
if(is.null(datasources)){
datasources <- datashield.connections_find()
}
# ensure datasources is a list of DSConnection-class
if(!(is.list(datasources) && all(unlist(lapply(datasources, function(d) {methods::is(d,"DSConnection")}))))){
stop("The 'datasources' were expected to be a list of DSConnection-class objects", call.=FALSE)
}
if(is.null(x)){
stop("x=NULL. Please provide the names of the objects to concatenate!", call.=FALSE)
}
# create a name by default if user did not provide a name for the new variable
if(is.null(newobj)){
newobj <- "c.newobj"
}
# check if the input object(s) is(are) defined in all the studies
lapply(x, function(k){isDefined(datasources, obj=k)})
# call the internal function that checks the input object(s) is(are) of the same class in all studies.
for(i in 1:length(x)){
typ <- checkClass(datasources, x[i])
}
# call the server side function that does the job
cally <- paste0("cDS(list(",paste(x,collapse=","),"))")
DSI::datashield.assign(datasources, newobj, as.symbol(cally))
# check that the new object has been created and display a message accordingly
finalcheck <- isAssigned(datasources, newobj)
}