R/format.R

In poissonconsulting/hmstimer: 'hms' Based Timer

#' Format hms Timer
#'
#' Converts a [hms_timer()] to a string of the clock time
#' after rounding it to the number of digits.
#'
#' Negative values of digit are not permitted.
#'
#' @inheritParams params
#' @return A character string.
#' @family round
#' @export
#' @examples
#' tmr_format(tmr_timer(61.66))
#' tmr_format(tmr_timer(61.66), digits = 0)
tmr_format <- function(x, digits = 3, ..., print_title = TRUE) {
  chk_digits(digits)
  rlang::check_dots_empty()

  if (digits < 0) err("`digits` must not be negative.")

  x <- tmr_round(x, digits = digits)
  msecs <- as.numeric(x) - floor(as.numeric(x))
  x <- tmr_floor(x)
  title <- tmr_title(x)
  x <- as.character(x)
  msecs <- formatC(msecs, digits = digits, format = "f")
  msecs <- substr(msecs, 2, nchar(msecs))
  x <- paste0(x, msecs)
  if (print_title) {
    x <- paste_title(x, title)
  }
  x
}