R/human_ts.R

In OpenSpecy: Analyze, Process, Identify, and Share Raman and (FT)IR Spectra

#' @title Create human readable timestamps
#'
#' @description
#' This helper function creates human readable timestamps in the form of
#' \code{\%Y\%m\%d-\%H\%M\%OS} at the current time.
#'
#' @details
#' Human readable timestamps are appended to file names and fields when metadata
#' are shared with the Open Specy community.
#'
#' @return
#' \code{human_ts()} returns a character value with the respective
#' timestamp.
#'
#' @examples
#' human_ts()
#'
#' @author
#' Win Cowger, Zacharias Steinmetz
#'
#' @seealso
#' \code{\link[base]{format.Date}} for date conversion functions
#'
#' @export
human_ts <- function() {
  Sys.time() |> format("%Y%m%d-%H%M%OS")
}