R/sec_to_hms.R

In avrincon/phukieo: Manipulate Behavioural Data

#' Function that converts seconds to a character format hh:mm:ss
#' @param secs a number of seconds to be formatted
#' @description
#' This function converts a number of seconds to a character format hh:mm:ss
#'
#' @return A character vector of formatted seconds
#' @examples
#' sec_to_hms(c(8, 66))
#' sec_to_hms(8 + 66)
#' @export


sec_to_hms <- function(secs) {

  # if(any(is.na(secs))) stop("Unable to format NA values.\n",
  #                           "Please remove NA values before running function")
  if(! is.numeric(secs)) stop("secs must be of class numeric")
  # if(any(secs < 0)) stop("secs must be a positive number")

  # integer division to ger the number of full min
  full.mins <- secs %/% 60

  # change duration format from period to character hh:mm:ss
  # integer division to get the number of full hours
  paste(formatC((full.mins %/% 60), width = 2, format = "d", flag = "0"),
        # remainder of the division is the number of minutes
        formatC((full.mins %% 60), width = 2, format = "d", flag = "0"),
        # remainder of the division is the number of secs
        formatC((secs %% 60), width = 2, format = "d", flag = "0"),
        sep = ":")
}