R/rhrAlert.R

In rhr: Package to estimate home ranges through a graphical user interface.

#' rhrAlert
#' Wraps a character as html \code{div} with appropriate alert classe to use with twitter bootstrap.

#' @param x a character
#' @param cat logical, if true results will be \code{cat} to the command line
#' @param class character, giving finer specification of the class, possible values are: error, info, success or warning.
#' @export
#' @return \code{character}

rhrAlert <- function (x, cat = TRUE, class="info") {
  if (!class %in% c("info", "error", "success", "warning")) {
    stop("rhrAlert: class: unknown class requested")
  }
  out <- paste0("<div class='alert ", class, "'>", x, "</div>")
  if (cat) {
    return(cat(out))
  }
  else {
    return(out)
  }
}