R/floor.R

Defines functions dts_floor

Documented in dts_floor

#' Floors the Date or POSIXct column of a date time series data frame.
#'
#' @inheritParams dttr2::dtt_complete
#' @inheritParams check_dts
#' @return The completed data time series.
#' @export
#'
#' @examples
#' dts_floor(dts_data[c(1,3),], units = "years")
dts_floor <- function(x, dtt = "DateTime", units = dttr2::dtt_units(x[[dtt]])) {
  check_dts(x, dtt = dtt)
  
  x[[dtt]] <- dtt_floor(x[[dtt]], units = units)
  x
}
poissonconsulting/dts documentation built on March 10, 2024, 6:21 a.m.