R/time.R

In stufield/stuRpkg: Stu's Utilities Package

#' Determine Time from Seconds (& vice versa)
#'
#' [time2seconds()] and [seconds2time()] determine the
#' time (format="hh:mm:ss.ss") from the value in seconds or vice versa.
#' Two digit hour precision optional.
#'
#' @rdname time
#' @aliases time2seconds seconds2time
#' @param x Character or Numeric. Of the form \code{"hh:mm:ss.ss"}
#' with 2 decimal point precision on the seconds to convert to seconds.
#' If numeric, the seconds to convert to a character string of
#' the form \code{"hh:mm:ss.ss"}.
#' @return Either number of seconds (`numeric`) or the time format
#' (`character`) as "hh:mm:ss.ss".
#' @author Stu Field
#' @seealso [strsplit()], [grep()]
#' @examples
#' seconds2time(159.72)
#'
#' @export
seconds2time <- function(x) {
  hours <- x %/% 3600
  mins  <- (x %% 3600) %/% 60
  secs  <- ((x %% 60) %% 60) %% 60
  decimals <- gsub(".*[0-9][.]", "", sprintf("%.2f", secs))
  #print(list(hours,mins,secs,decimals))
  sprintf("%01d:%02d:%02d.%s", hours, mins, round(secs, 0), decimals)
}


#' Determine Seconds from Time
#'
#' @rdname time
#' @examples
#' time2seconds("3:44:12.04")
#' time2seconds("15:44:12.04")
#' @export
time2seconds <- function(x) {
  format_check <- grepl("^[0-9]{1,2}:[0-9]{2}:[0-9]{2}[.][0-9]{1,2}$", x)
  if ( !format_check ) {
    usethis::ui_stop(
      "Incorrect time format ... check time format is 'hh:mm:ss.ss'"
    )
  }
  char_split <- strsplit(x, split = ":", fixed = TRUE)[[1]]
  convert    <- as.numeric(char_split)
  hr  <- convert[1L]
  min <- convert[2L]
  sec <- convert[3L]
  return(hr * 60 + min * 60 + sec)
}