R/check-scalar-hasClusters.R

In steinbaugh/goalie: Assertive Check Functions

#' Does the input object contain clusters?
#'
#' @name check-scalar-hasClusters
#' @note Updated 2023-09-29.
#'
#' @inherit check
#' @inheritParams AcidRoxygen::params
#'
#' @seealso `AcidGenerics::clusters`.
#'
#' @examples
#' data(SingleCellExperiment_Seurat, package = "AcidTest")
#'
#' ## TRUE ====
#' if (requireNamespace("AcidSingleCell", quietly = TRUE)) {
#'     hasClusters(SingleCellExperiment_Seurat)
#' }
#'
#' ## FALSE ====
#' hasClusters(list())
NULL



#' @rdname check-scalar-hasClusters
#' @export
hasClusters <- function(x) {
    requireNamespaces("AcidGenerics")
    ok <- tryCatch(
        expr = {
            is.factor(AcidGenerics::clusters(x))
        },
        error = function(e) {
            FALSE
        }
    )
    if (!isTRUE(ok)) {
        return(false(
            "{.var %s} does not contain clusters.",
            .toName(x)
        ))
    }
    TRUE
}