R/date.R

In checkr: Check the Properties of Common R Objects

#' Check Date
#' 
#' Checks if x is a date (non-missing unnamed Date scalar).
#'
#' @param x The object to check.
#' @param x_name A string of the name of the object.
#' @param coerce A flag indicating whether to coerce a date time (POSIXt scalar) to a Date and remove names.
#' @param error A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.
#' @return An invisible copy of x (if it doesn't throw an error).
#' @seealso \code{\link{check_datetime}}
#' @export
#'
#' @examples
#' check_date(Sys.Date(), error = FALSE)
#' check_date(Sys.time(), error = FALSE)
#' check_date(Sys.time(), coerce = TRUE, error = FALSE)
check_date <- function(x,
                       coerce = FALSE,
                       x_name = substitute(x),
                       error = TRUE) {
  x_name <- chk_deparse(x_name)
  
  check_flag_internal(coerce)
  check_flag_internal(error)
  
  if(coerce && is.POSIXt(x)) {
    x <- as.Date(x, tz = tz(x))
    x <- unname(x)
  }
  check_scalar(x, values = as.Date("2001-01-01"), attributes = TRUE,
               x_name = x_name, error = error)
}

#' @rdname check_date
#' @export
check_day <- function(x,
                       coerce = FALSE,
                       x_name = substitute(x),
                       error = TRUE) {
  x_name <- chk_deparse(x_name)
  
  check_date(x, coerce = coerce, x_name = x_name, error = error)
}