R/check-scalar-isBiocParallelParam.R

In steinbaugh/goalie: Assertive Check Functions

#' Does the input contain a BiocParallel parameter?
#'
#' @name check-scalar-isBiocParallelParam
#' @note Updated 2023-07-21.
#'
#' @inherit check
#' @inheritParams AcidRoxygen::params
#'
#' @seealso `BiocParallel::bpparam`.
#'
#' @examples
#' ## TRUE ====
#' if (isInstalled("BiocParallel")) {
#'     isBiocParallelParam(BiocParallel::bpparam())
#' }
#'
#' ## FALSE ====
#' isBiocParallelParam(list())
NULL



#' @rdname check-scalar-isBiocParallelParam
#' @export
isBiocParallelParam <- function(x) {
    ok <- all(
        identical(
            attributes(class(x))[["package"]],
            "BiocParallel"
        ),
        grepl("Param$", class(x))
    )
    if (!isTRUE(ok)) {
        return(false(
            "{.var %s} is not a BiocParallel param.",
            .toName(x)
        ))
    }
    TRUE
}