R/VerifyCriticalValue.R

In dtrSurv: Dynamic Treatment Regimes for Survival Analysis

# Verify input 'criticalValue'
#
# methods are not exported and are only for internal convenience
#
# ensures that 'criticalValue' is one of {'mean', 'surv.prob', 'surv.man'}. 
#
# successful methods return the original character possibly modified to be 
# all lower case.
#
setGeneric(name = ".VerifyCriticalValue",
           def = function(criticalValue, ...) { 
                   standardGeneric(".VerifyCriticalValue") 
                 })

# the default method generates an error
setMethod(f = ".VerifyCriticalValue",
          signature = c(criticalValue = "ANY"),
          definition = function(criticalValue, ...) { 
              stop("criticalValue must be one of ",
                   "{'mean', 'surv.prob', 'surv.mean'}", 
                   call. = FALSE)
            })

setMethod(f = ".VerifyCriticalValue",
          signature = c(criticalValue = "character"),
          definition = function(criticalValue, ...) { 

              criticalValue <- tolower(x = criticalValue)

              if (criticalValue %in% c("mean", "surv.prob", "surv.mean"))
                return( criticalValue )

              stop("criticalValue must be one of ",
                   "{'mean', 'surv.prob', 'surv.mean'}", 
                   call. = FALSE)

            })