R/check-scalar-isDark.R

In acidgenomics/r-goalie: Assertive Check Functions

#' Is dark mode preferred?
#'
#' @name check-scalar-isDark
#' @note Updated 2022-03-08.
#'
#' @details
#' Checks for `acid.dark` option in current session.
#'
#' Useful for changing the appearance of ggplot2 output, especially for single
#' cell RNA-seq clustering plots.
#'
#' @return `logical(1)`.
#'
#' @examples
#' ## TRUE ====
#' options("acid.dark" = TRUE)
#' isDark()
#'
#' ## FALSE ====
#' options("acid.dark" = NULL)
#' isDark()
NULL



#' @rdname check-scalar-isDark
#' @export
isDark <- function() {
    ok <- isTRUE(getOption(x = "acid.dark"))
    if (!isTRUE(ok)) {
        return(false("Dark mode is not enabled."))
    }
    TRUE
}