R/Tools.R

In j2scode/nlpStudio: Natural Language Processing Environment

#==============================================================================#
#                                     Tools                                    #
#==============================================================================#
#' Tools
#'
#' \code{Tools} Class containing various helper methods used within the package.
#'
#' @section Tools Methods:
#' \describe{
#'  \item{\code{makeRandomString(len = 12)}}{Returns a random string of the requested length.}
#' }
#'
#' @param len The length of the requested random string.
#'
#' @docType class
#' @author John James, \email{jjames@@datasciencesalon.org}
#' @export
Tools <- R6::R6Class(
  classname = "Tools",
  lock_objects = FALSE,
  lock_class = FALSE,

  public = list(

    makeRandomString = function(len = 12) {

      v <- ValidatorNumeric$new()
      if (v$validate(class = "Tools", method = "makeRandomString",
                 fieldName = "len", value = len, level = "Info",
                 msg = paste("Invalid length, random string of length 12 returned.",
                             "See ?Tools for further assistance."),
                 expect = TRUE) == FALSE) {
        len <- 12
      }
      return(paste0(sample(c(0:9, letters, LETTERS),
                           size = len, replace=TRUE),
                    collapse = ""))
    },


    parseDate = function(date, class = "Tools", method = "parseDate") {
      v <- ValidatorDate$new()
      date <- v$validate(class = class, method = method,
                         fieldName = "date", value = date, level = "Error",
                         msg = paste("Date parameter not recognized. The",
                                     "recommended date format is 'YYYY-MM-DD'.",
                                     "See ?",class, "for further assistance."),
                         expect = TRUE)
      return(date)
    }
  )
)