R/dssSetOption.R

In sib-swiss/dsSwissKnifeClient: DataSHIELD Tools and Utilities - client side

#' @title Set  options in remote R sessions
#' @param option_list a list describing the options to be set
#' @param async a logical, see datashield.aggregate

#' @param  datasources a list of opal objects obtained after logging into the opal servers (see datashield.login)
#' @return  TRUE if succesful
#' @examples
#' dssSetOption(list(stringsAsFactors = TRUE, digits = 2), datasources = my_datasources)
#' @export
#'


dssSetOption <- function(option_list,  async = TRUE, datasources = NULL){
  if(is.null(datasources)){
    datasources <- datashield.connections_find()
  }

  expr <- list(as.symbol('setOptionDSS'), .encode.arg(option_list))

  datashield.aggregate(datasources,as.call(expr), async=async)

}
#' @title Get options from remote R sessions
#' @param opt the name of the option. If nULL all the session options will be retrieved
#' @param async a logical, see datashield.aggregate

#' @param  datasources a list of opal objects obtained after logging into the opal servers (see datashield.login)
#' @return  a list with the option values
#' @examples
#' dssGetOption( datasources = my_datasources)
#' @export
#'


dssGetOption <- function(opt = NULL,  async = TRUE, datasources = NULL){
  if(is.null(datasources)){
    datasources <- datashield.connections_find()
  }

  expr <- list(as.symbol('getOptionDSS'), .encode.arg(opt))

  datashield.aggregate(datasources,as.call(expr), async=async)

}