R/deprecationCheck.R

In Maritimes/Mar.utils: A suite of functions used by a variety of Maritimes packages

#' @title  Check for Deprecated Parameters
#' @description This function checks for deprecated parameters and issues a 
#' warning if any are found.  
#' @param ... Parameters to check for deprecation.
#' @author  Mike McMahon, \email{Mike.McMahon@@dfo-mpo.gc.ca}l
#' @export
deprecationCheck <- function(...) {
  params <- list(...)
  deprecated_params <- c("fn.oracle.username", "fn.oracle.password", "fn.oracle.dsn", "usepkg")
  
  fn_params <- c("fn.oracle.username", "fn.oracle.password", "fn.oracle.dsn")
  params_are_none <- all(sapply(params[fn_params], function(x) x == "_none_"))
  usepkg_deprecated <- "usepkg" %in% names(params) && params[["usepkg"]] %in% c("roracle", "rodbc")
  
  if (params_are_none && usepkg_deprecated) {
    return()
  }
  
  deprecated_input <- deprecated_params[deprecated_params %in% names(params) & 
                                          !sapply(params[deprecated_params], function(x) is.null(x) || is.na(x) || x == "_none_")]
  
  if (any(deprecated_input %in% c("fn.oracle.username", "fn.oracle.password", "fn.oracle.dsn", "usepkg"))) {
    warning("The parameters 'fn.oracle.username', 'fn.oracle.password', 'fn.oracle.dsn', and 'usepkg' are deprecated. Please use the 'cxn' parameter to pass an existing Oracle connection.")
    deprecated_input <- setdiff(deprecated_input, c("fn.oracle.username", "fn.oracle.password", "fn.oracle.dsn", "usepkg"))
  }
  
  for (param in deprecated_input) {
    warning(paste("The parameter", param, "is deprecated. Please use the 'cxn' parameter to pass an existing Oracle connection."))
  }
}