R/separate.R

In poissonconsulting/dts: Manipulate Date/POSIXct Time Series Data Frames

#' Separates the DateTime column of a data frame into its component parts.
#'
#' @param x A data frame with a Date or POSIXct column.
#' @inheritParams check_dts
#' @param year A flag indicating whether to add a Year column.
#' @param month A flag indicating whether to add a Month column.
#' @param day A flag indicating whether to add a Day column.
#' @param hour A flag indicating whether to add a Hour column.
#' @param minute A flag indicating whether to add a Minute column.
#' @param second A flag indicating whether to add a Second column.
#' @param dayte A flag indicating whether to add a Dayte column.
#' @param prefix A string to add to the start of the column names.
#' @param suffix A string to add to the end of the column names.
#'
#' @return The updated data frame.
#' @export
#'
#' @examples
#' dts_separate_date_time(dts_data[c(1,3),])
dts_separate_date_time <- function(
  x, dtt = "DateTime", year = TRUE, month = TRUE, day = TRUE, 
  hour = TRUE, minute = TRUE, 
  second = TRUE, dayte = FALSE,
  prefix = "", suffix = "") {
  
  check_dts(x, dtt)
  
  chk_flag(year)
  chk_flag(month)
  chk_flag(day)
  chk_flag(hour)
  chk_flag(minute)
  chk_flag(second)
  chk_flag(dayte)
  chk_string(prefix)
  chk_string(suffix)
  
  if(year) x[[paste0(suffix, "Year", prefix)]] <- dtt_year(x[[dtt]])
  if(month) x[[paste0(suffix, "Month", prefix)]] <- dtt_month(x[[dtt]])
  if(day) x[[paste0(suffix, "Day", prefix)]] <- dtt_day(x[[dtt]])
  if(hour) x[[paste0(suffix, "Hour", prefix)]] <- dtt_hour(x[[dtt]])
  if(minute) x[[paste0(suffix, "Minute", prefix)]] <- dtt_minute(x[[dtt]])
  if(second) x[[paste0(suffix, "Second", prefix)]] <- dtt_second(x[[dtt]])
  if(dayte) x[[paste0(suffix, "Dayte", prefix)]] <- dtt_dayte(x[[dtt]])
  x
}

#' @describeIn dts_separate_date_time Separate Date
#' @export
dts_separate_date <- function(
  x, dtt = "DateTime", year = TRUE, month = TRUE, day = TRUE, dayte = FALSE,
  prefix = "", suffix = "") {
  dts_separate_date_time(x, dtt = dtt, year = year, month = month, day = day,
                         hour = FALSE, minute = FALSE, second = FALSE, dayte = dayte,
                         prefix = prefix, suffix = suffix)
}