R/str_ugm3.R

In BAAQMD/strtools: Parse, Format, and Manipulate Strings

#' str_ugm3
#'
#' @param format (character) one of "character", "utf8", "html", "TeX", or "markdown"
#' @param verbose (logical)
#'
#' @return representation of "ug/m3" (micrograms per cubic meter)
#'
#' @export
str_ugm3 <- function (
  format = c("character", "utf8", "html", "TeX", "markdown"),
  verbose = getOption("verbose", default = FALSE)
) {
  msg <- function(...) if (isTRUE(verbose))
    message("[str_ugm3] ", ...)
  if (missing(format)) {
    if (isTRUE(knitr::is_html_output())) {
      format <- "html"
    }
    else if (isTRUE(knitr::is_latex_output())) {
      format <- "TeX"
    }
    else {
      format <- match.arg(format)
    }
  }
  else {
    format <- match.arg(format)
  }
  if (format == "character") {
    token <- "ug/m3"
  }
  else if (format == "utf8") {
    token <- "µg/m³"
  }
  else if (format == "html") {
    token <- "µg/m<sup>3</sup>"
  }
  else if (format == "TeX") {
    token <- "µg/m$^3$"
  }
  else if (format == "markdown") {
    token <- "µg/m^3^"
  }
  else {
    stop("Unknown format ", format)
  }
  return(token)
}