R/alert.R

In acidgenomics/r-acidcli: Acid Genomics Command Line Interface

#' Alert messages
#'
#' @name alert
#' @note Updated 2021-08-18.
#'
#' @param x `character`.
#'
#' @return Console output, with invisible return of `x` input.
#'
#' @seealso
#' - `cli::cli_alert()`.
#' - `cli::cli_alert_info()`.
#' - `cli::cli_alert_success()`.
#' - `cli::cli_alert_warning()`.
#'
#' @examples
#' x <- "hello world"
#' alert(x)
#' alertDanger(x)
#' alertInfo(x)
#' alertSuccess(x)
#' alertWarning(x)
NULL



#' @rdname alert
#' @export
alert <- function(x) {
    assert(isCharacter(x))
    lapply(X = x, FUN = cli_alert)
    invisible(x)
}



#' @rdname alert
#' @export
alertDanger <- function(x) {
    assert(isCharacter(x))
    lapply(X = x, FUN = cli_alert_danger)
    invisible(x)
}



#' @rdname alert
#' @export
alertInfo <- function(x) {
    assert(isCharacter(x))
    lapply(X = x, FUN = cli_alert_info)
    invisible(x)
}



#' @rdname alert
#' @export
alertSuccess <- function(x) {
    assert(isCharacter(x))
    lapply(X = x, FUN = cli_alert_success)
    invisible(x)
}



#' @rdname alert
#' @export
alertWarning <- function(x) {
    assert(isCharacter(x))
    lapply(X = x, FUN = cli_alert_warning)
    invisible(x)
}