R/error_messages.r

In envnames: Keep Track of User-Defined Environment Names

# Functions that show error messages
#
# Purpose: Concentrate all error messages in one place. 
#
# Error functions should start with prefix 'error_'
# Warning functions should start with prefix 'warning_'
# etc.
#
# The function name should then sum up what type of message is shown using Camel notation (e.g. NotValidEnvironment)

error_NotValidEnvironment = function(envir_name) {
  fun_name = get_fun_name(n=1)
  tryCatch(msg <- paste("ERROR: (", fun_name, ") '", envir_name, "' is not a valid environment.", sep=""), error=function(e) msg <<- "The variable passed is not a valid environment", silent=TRUE)
  message(msg)
}

error_NotValidExpression = function(expr) {
	fun_name = get_fun_name(n=1)
	tryCatch(msg <- paste("ERROR: (", fun_name, ") '", expr, "' is not a valid expression to evaluate.", sep=""), error=function(e) msg <<- "The expression passed as parameter is not valid.", silent=TRUE)
	message(msg)
}

error_NotValidArchitecture = function(arch) {
  fun_name = get_fun_name(n=1)
  tryCatch(msg <- paste("ERROR: (", fun_name, ") '", arch, "' is not a valid architecture supported by the envnames package.\nSupported architectures are '", .pkgenv$ARCH_32BIT, "' (32-bit) and '", .pkgenv$ARCH_64BIT, "' (64-bit).", sep=""),
           error=function(e) msg <<- "The input parameter is not a string. It should contain the name of an architecture (e.g. 'x86_64')", silent=TRUE)
  message(msg)
}