R/reportWrongPlotName.R

In ShashankKumbhare/paramonteR: Plain Powerful Parallel Monte Carlo Library

####################################################################################################################################
################################## reportWrongPlotName #############################################################################
# >>
reportWrongPlotName  <- function(plotNames, className) {
    
    # private$Err$prefix = private$methodName
    
    private$Err$abort  = paste0( c( "The input argument ``plotNames`` must be a string representing", "\n",
                                    "the name of a plot belonging to the ", className, "class or,", "\n",
                                    "a 1d-vector of such plot names. You have entered: ", plotNames, "\n",
                                    "\n",
                                    "Possible plots are: ", "\n",
                                    "\n",
                                    paste0(private$plotTypeList, "\n"),
                                    "\n",
                                    "Here is the help for the ``reset()`` method: ", "\n",
                                    "NEED TO ADD DOC HERE" ) )
    
    return(invisible(self))
    
}
# <<
################################## reportWrongPlotName #############################################################################
####################################################################################################################################


####################################################################################################################################
################################## Help Code #######################################################################################
# >>
# private$reportWrongPlotName(plotNames)
# <<
################################## Help Code #######################################################################################
####################################################################################################################################