R/error.msgs.R

In feranpre/feR: Basic functions that I use all the time

#'
#' @author Fernando Andres-Pretel
#'




# TODO:
#  - cleanup
#  - standarize names
#  - documentantion

#'
#' @importFrom crayon bold green red
#'
.error.msg <- function(error="DEFAULT", lang = "es", stop.on.error = TRUE, FUN = NULL) {
  if (is.null(FUN)) FUN <- deparse(sys.calls()[[sys.nframe() - 1]])
  error_msg.es <- c(
    "DEFAULT" = "Ha habido un problema inespecífico",
    "MISSING_X" = "falta 'x'",
    "MISSING_BY" = "falta 'by'",
    "MEAN_NOT_NUMERIC" = "'x' debe ser un vector numérico o un data.frame con al menos una variable numérica",
    "DIFF_LEN_VECTOR" = "'by' y 'x' tienen tamaños diferentes",
    "2_GROUPS" = "there must be exactly 2 groups",
    "NOT_ENOUGH_X_OBS" = "not enough 'x' observations",
    "NOT_ENOUGH_BY_OBS" = "not enough 'by' observations",
    "MISSING_CI" = "missing 'confidence interval'",
    "CI_LIMITS" = "'confidence interval' must be a number > 0 and < 1",
    "T_TEST_NOT_VALID" = "el test especificado no es correcto. Las opciones disponibles son: 'auto', 'wilcoxon', 'student' y 'welch'",
    "ALTERNATIVE_T_TEST_NOT_VALID" = "se ha especificado una hypotesis alternativa no correcta. Las opciones disponbiles son: 'two.sided', 'less' y 'greater'",
    "X_VAR_NOT_IN_DF" = "se han indicado nombres de variables que no existen en la base de datos",
    "BY_IS_DATA_FRAME" = "'by' es un data.frame",
    "X_N_TOO_LOW" = "la cantidad de observaciones en 'x' es insuficiente",


    "T_STUDENT" = "Ha habido un problema al realizar un t.test (Student)" ,
    "T_WELCH" = "Ha habido un problema al realizar un t.test (Welch)",




    "MEAN_BY" = "Se ha especificado una variable de agrupación que no puede ser usada",
    "MEAN_COMP_X_MISSING" = "Falta vector de datos numéricos 'X' para comparación de medias",
    "MEAN_COMP_Y_MISSING" = "Falta vector de datos numéricos 'Y' para comparación de medias",
    "MEAN_COMP_PAIRED_MUST_BE_2" = "Para comparar medias apareadas hace falta que el data.frame tenga solo dos variables",
    "MEAN_COMP_BY_MISSING" = "Falta factor de agrupacion para comparación de medias",
    "MEAN_COMP_BY_ERROR" = "Se ha detectado un factor de agrupación pero no puede usarse por algún motivo",
    "VARIANCE_TEST_X_MISSING" = "Falta variable numérica para test de varianzas",
    "VARIANCE_TEST_BY_MISSING" = "Falta factor de agrupacion para test de varianzas",
    "VARIANCE_TEST_1_GROUP" = "La variable grupo necesita ser categorica y tener al menos 2 niveles"
  )

  error_msg.en <- c(


    "MISSING_X" = "missing 'x'",
    "MISSING_BY" = "missing 'by'",
    "MEAN_NOT_NUMERIC" = "'x' must either be a numeric vector or a data.frame with at least 1 numeric vector",
    "DIFF_LEN_VECTOR" = "vectors have differente lenghts",


    "NOT_ENOUGH_X_OBS" = "not enough 'x' observations",
    "NOT_ENOUGH_BY_OBS" = "not enough 'by' observations",
    "MISSING_CI" = "missing 'confidence interval'",
    "CI_LIMITS" = "'confidence interval' must be a number > 0 and < 1",


    "ALTERNATIVE_T_TEST_NOT_VALID" = "an alternative hypothesis was specified that is not correct. Correct options are: 'two.sided', 'less' and 'greater'",
    "X_VAR_NOT_IN_DF" = "variable names were given that cannot be found in 'x' data.frame",
    "BY_IS_DATA_FRAME" = "'by' is a data.frame",
    "X_N_TOO_LOW" = "not enough observations in 'x'",

    #-------------- T_TEST
    "2_GROUPS" = "there must be exactly 2 groups",
    "T_TEST_NOT_VALID" = "t test specified is not correct. Correct options are: 'auto', 'wilcoxon', 'student' and 'welch'",

    #-------------- ANOVA
    "ANOVA_TEST_NOT_VALID" = "test specified is not correct. Correct options are:'auto', 'anova' and 'kruskall-wallis'",
    "LESS_3_GROUPS" = "there must be more than 2 groups",

    "DEFAULT" = "Error"
  )

  if (lang == "es") {
    if (!is.na(error_msg.es[error])) msg <- error_msg.es[error]
    else if (!is.na(error_msg.en[error])) msg <- error_msg.en[error]
    else msg <- "Error"
  } else {
    if (!is.na(error_msg.en[error])) msg <- error_msg.en[error]
    else msg <- "Error"
  }



  crayon <- "crayon" %in% installed.packages()
  if (crayon) crayon.x <- crayon::red(crayon::bold("✗  "))
  else crayon.x <- "✗  "

  msg <- paste0("[",FUN,"] ",msg)

  if (stop.on.error) stop(crayon.x,msg, call. = F)
  message(crayon.x,msg)
  return(NA)
}