R/meanDS.R

In datashield/dsTutorial: DataSHIELD server side functions for my first package

#'
#' @title Computes statistical mean of a vectores
#' @description Calculates the mean value.
#' @details if the length of input vector is less than the set filter
#' a missing value is returned. 
#' @param xvect a vector
#' @return a numeric, the statistical mean
#' @author Gaye, A.
#' @export
#'
meanDS <- function (xvect) {
  
  # check if the input vector is valid (i.e. meets DataSHIELD privacy criteria)
  check <- isValidDS(xvect)
  
  # return missing value if the input vector is not valid
  if(!check){
    result <- mean(xvect, na.rm=TRUE) 
  }else{
    result <- NA
  }
  
  return(result)
}