R/sanitizePercent-methods.R

In acidgenomics/pipette: Pipette Biological Data In and Out of R

#' @name sanitizePercent
#' @inherit AcidGenerics::sanitizePercent
#' @note Updated 2019-10-12.
#'
#' @inheritParams AcidRoxygen::params
#' @param ... Additional arguments.
#'
#' @examples
#' ## character ====
#' object <- c("100%", "10.0%", "1%", "0.1%", "0.01%")
#' object <- sanitizePercent(object)
#' class(object)
#' print(object)
NULL



## Updated 2019-07-19.
`sanitizePercent,atomic` <- # nolint
    function(object) {
        object
    }



## Updated 2022-05-03.
`sanitizePercent,character` <- # nolint
    function(object) {
        if (allAreMatchingRegex(x = object, pattern = "%$")) {
            as.numeric(sub("%$", "", object)) / 100L
        } else {
            object
        }
    }



#' @rdname sanitizePercent
#' @export
setMethod(
    f = "sanitizePercent",
    signature = signature(object = "atomic"),
    definition = `sanitizePercent,atomic`
)

#' @rdname sanitizePercent
#' @export
setMethod(
    f = "sanitizePercent",
    signature = signature(object = "character"),
    definition = `sanitizePercent,character`
)