R/setupCNSIMTest.R

In DSLite: 'DataSHIELD' Implementation on Local Datasets

#' Setup a test environment based on the CNSIM simulated datasets
#'
#' Load the CNSIM datasets, the corresponding login data object, instanciate a new \link{DSLiteServer}
#' hosting these datasets and verify that the required DataSHIELD server-side packages are installed.
#'
#' @param packages DataSHIELD server-side packages which local installation must be verified so that the \link{DSLiteServer}
#' can auto-configure itself and can execute the DataSHIELD operations. Default is none.
#' @param env The environment where DataSHIELD objects should be looked for: the \link{DSLiteServer} and
#' the DSIConnection objects. Default is the Global environment.
#' @return The login data for the \link{datashield.login} function.
#' @family setup functions
#' @examples
#' \dontrun{
#' logindata <- setupCNSIMTest()
#' conns <- datashield.login(logindata, assign=TRUE)
#' # do DataSHIELD analysis
#' datashield.logout(conns)
#' }
#' @export
setupCNSIMTest <- function(packages = c(), env = parent.frame()) {
  setupDSLiteServer(packages, c("CNSIM1", "CNSIM2", "CNSIM3"),
                    "logindata.dslite.cnsim", "DSLite", "dslite.server", env)
}