Assert that an object is a date-time — assert

Checks that x is a date-time, that is, of class POSIXct (as returned by Sys.time(), as.POSIXct(), and lubridate functions such as ymd_hms()). Allows any length; for a single value use assert_scalar_datetime().

Usage

assert_datetime(
  x,
  null_ok = FALSE,
  arg = rlang::caller_arg(x),
  call = rlang::caller_env()
)

Arguments

x: Object to check.
null_ok: Single logical. If TRUE, a NULL value passes the check without error. Use this for optional arguments that default to NULL. Defaults to FALSE, so NULL is rejected unless you opt in.
arg: Name used to refer to x in error messages. Defaults to the name of the expression passed as x.
call: Environment used as the error's call context. Defaults to the calling function, so errors point at the user's code.

Value

The input x, invisibly.

Examples

assert_datetime(Sys.time())