R/checkResetType.R

In ShashankKumbhare/paramonteR: Plain Powerful Parallel Monte Carlo Library

####################################################################################################################################
################################## checkResetType ##################################################################################
# >>
checkResetType  <- function(resetType) {
    
    if ( is.character(resetType) & NCOL(resetType) == 1 & NROW(resetType) == 1 ) {
        
        resetTypeIsHard = tolower(resetType) == "hard"
        
    } else {
        
        private$Err$prifix = private$methodName
        private$Err$abort  = paste0("The input argument resetType must be a string representing", "\n",
                                    "the type of the reset to be performed on the plots.", "\n",
                                    "A list of possible plots includes: 'hard', 'soft'", "\n",
                                    "Here is the help for the ``reset()`` method: ", "\n",
                                    "\n",
                                    "NEED TO ADD DOC HERE")
        
    }
    
    return( resetTypeIsHard )
    
}
# <<
################################## checkResetType ##################################################################################
####################################################################################################################################


####################################################################################################################################
################################## Help Code #######################################################################################
# >>
# out = checkResetType(resetType)
# <<
################################## Help Code #######################################################################################
####################################################################################################################################