R/rccValidators.R

In R.methodsS3: S3 Methods Simplified

rccValidateFunctionName <- function(name, ...) {
  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  # Validate 'name'
  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  # Assert that the generic function name is a valid function name.
  firstLetter <- substring(gsub("^[.]*", "", name), 1,1)

  allowedFirst <- c("?", "$", "$<-", "[", "[<-", "[[", "[[<-")
  allowedFirst <- c(allowedFirst, "+", "-", "*", "^", "%")
  if (!is.element(firstLetter, allowedFirst)) {
    if (!is.element(tolower(firstLetter), letters))
      stop("Except for a few operators, method/function names must begin with a letter: ", name)

    # Check first letter  
    if (firstLetter == toupper(firstLetter))
      stop("Method/function names should start with a lower case letter: ", name)
  }
}
export(rccValidateFunctionName) <- FALSE

rccValidateSetMethodS3 <- function(name, ...) {
  rccValidateFunctionName(name=name)
}
export(rccValidateSetMethodS3) <- FALSE

rccValidateSetGenericS3 <- function(name, ...) {
  rccValidateFunctionName(name=name)
}
export(rccValidateSetGenericS3) <- FALSE