R/ji.ds.colnames.R

In datashield/ji.dev.cl: ji.dev.cl

#' 
#' @title Retrieves column names of a matrix-like object
#' @description this function is similar to R function \code{colnames}
#' @param datasources a list of opal object(s) obtained after login in to opal servers;
#' these objects hold also the data assign to R, as \code{dataframe}, from opal datasources.
#' @param x a matrix-like object
#' @return a string containing column names of the given object
#' @author Gaye, A. (amadou.gaye@bristol.ac.uk) and Isaeva, J. (julia.isaeva@fhi.no)
#' @export
#' @examples {
#' 
#' # load that contains the login details
#' data(logindata)
#' 
#' # login
#' opals <- datashield.login(logins=logindata,assign=TRUE)
#' 
#' # Example 1: Get the column names of the assigned datasets
#' ji.ds.colnames(datasources=opals, x=quote(D))
#' 
#' # Example 2: Vectors are wrong input to the colnames function
#' ji.ds.colnames(datasources=opals, x=quote(D$LAB_TSC))
#' }
#' 
ji.ds.colnames = function(datasources=NULL, x=NULL) {
  if(is.null(datasources)){
    message("\n\n ALERT!\n")
    message(" No valid opal object(s) provided.\n")
    message(" Make sure you are logged in to valid opal server(s).\n")
    stop(" End of process!\n\n", call.=FALSE)
  }
  
  if(is.null(x)){
    message("\n\n ALERT!\n")
    message(" Please provide a valid matrix-like object\n")
    stop(" End of process!\n\n", call.=FALSE)
  }
  
  # check whether a given vector is a matrix like object
  numsources = length(datasources)
  cally = call('class', x)
  classes_x = datashield.aggregate(datasources, cally)
  flag = 0  
  for (i in 1:numsources) {
    if ( (classes_x[[i]]!='matrix') && (classes_x[[i]]!='data.frame') ){
      message("\n\n ALERT!\n")
      message(" Please provide a valid matrix-like object for study ",i, "\n")
      flag=1
    }
  }
  if (flag==1)
    stop(" End of process!\n\n", call.=FALSE)

  
  cally <- call('colnames', x )
  column_names <- datashield.aggregate(datasources, cally)
  
  return(column_names)
}