R/recodeLevelsDS.R

In datashield/dsBase: DataSHIELD server site base functions

#' 
#' @title Recodes the levels of a categorical variables
#' @description The functions uses the input factor and generates a new factor 
#' with new levels.
#' @param x a factor vector
#' @param classes a character vector the levels of the  newt factor vector
#' @return a factor vector with the new levels
#' @author Gaye, A.
#' @export
#'
recodeLevelsDS <- function (x=NULL, classes=NULL){
  
  # Check Permissive Privacy Control Level.
  dsBase::checkPermissivePrivacyControlLevel(c('permissive', 'banana'))
  
  # check if the input vector is valid (i.e. meets DataSHIELD criteria)
  check <- isValidDS(x)
  
  if(check){
    # generate the new variable with the specified levels
    levels(x) <- classes
  }else{
    # generate the new variable with the specified levels but with missing values
    x[1:length(x)] <- NA
  }
  
  return(x)
  
}