R/utils.R

In signs: Insert Proper Minus Signs

check_args <- function(format,
                       add_plusses,
                       trim_leading_zeros,
                       label_at_zero) {

  # error msgs only work as written b/c I used consistent arg names throughout
  # otherwise rlang::ensym would do the trick
  if (!is.function(format) || !is.character(format(1))) {
    stop(
      "`format` should be a function that returns a character vector, ",
      "such as `scales::number` or `as.character`. ",
      "Consider setting a default with ",
      "`options(signs.format = your_function)`."
    )
  }

  # could have simply used isTRUE w/ add_plusses and trim_leading_zeros,
  # but I prefer to throw informative errors
  if (!is.logical(add_plusses) || length(add_plusses) > 1) {
    stop("`add_plusses` should be a logical vector of length 1.")
  }
  if (!is.logical(trim_leading_zeros) || length(trim_leading_zeros) > 1) {
    stop("`trim_leading_zeros` should be a logical vector of length 1.")
  }

  if (!is.character(label_at_zero) ||
      length(label_at_zero) > 1 ||
      !(label_at_zero %in% c("none", "blank", "symbol"))) {
    stop("`label_at_zero` should be either 'none', 'blank', or 'symbol'.")
  }
}