check_dttm: Check Date Time

In poissonconsulting/checkr: Check the Properties of Common R Objects

Check Date Time

Description

Checks if x is a datetime (non-missing unnamed POSIXct scalar).

Usage

check_dttm(
  x,
  coerce = FALSE,
  tzone = "UTC",
  x_name = substitute(x),
  error = TRUE
)

check_datetime(
  x,
  coerce = FALSE,
  tzone = "",
  x_name = substitute(x),
  error = TRUE
)

Arguments

x	The object to check.
coerce	A flag indicating whether to coerce a date to a dttm (using the time zone tzone) and remove names.
tzone	A string of the time zone where "" is the current time zone.
x_name	A string of the name of the object x.
error	A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.

Value

An invisible copy of x (if it doesn't throw an error).

See Also

check_scalar

Examples

check_dttm(Sys.Date(), error = FALSE)
check_dttm(Sys.time(), error = FALSE)

poissonconsulting/checkr documentation built on Oct. 18, 2023, 9:39 p.m.