R/check-scalar-isAny.R

In acidgenomics/goalie: Assertive Check Functions

#' Does the object belong to or inherit any of these classes?
#'
#' @name check-scalar-isAny
#' @note Updated 2019-10-04.
#'
#' @inherit check
#' @inheritParams AcidRoxygen::params
#'
#' @examples
#' x <- 1L
#'
#' ## TRUE ====
#' isAny(x, classes = c("integer", "NULL"))
#' isAny(x, classes = c("numeric", "NULL"))
#' isAny(x, classes = c("atomic", "NULL"))
#'
#' ## FALSE ====
#' isAny(x, classes = c("character", "data.frame"))
NULL



#' @rdname check-scalar-isAny
#' @export
isAny <- function(x, classes) {
    ok <- isCharacter(classes)
    if (!isTRUE(ok)) {
        return(ok)
    }
    ok <- any(.is2(x, class = classes))
    if (!isTRUE(ok)) {
        return(false(
            "{.var %s} is not any of: %s.",
            .toName(x), toString(classes, width = 50L)
        ))
    }
    TRUE
}