Check Date — chk_date • chk

Checks non-missing Date scalar using

inherits(x, "Date") && length(x) == 1L && !anyNA(x)

Usage

chk_date(x, x_name = NULL)

vld_date(x)

Arguments

x: The object to check.
x_name: A string of the name of object x or NULL.

Value

The chk_ function throws an informative error if the test fails or returns the original object if successful so it can used in pipes.

The vld_ function returns a flag indicating whether the test was met.

Functions

vld_date(): Validate Date

See also

For more details about the use of this function, please read the article vignette("chk-families").

Other scalar_checkers: chk_count(), chk_date_time(), chk_false(), chk_flag(), chk_lgl(), chk_scalar(), chk_string(), chk_true(), chk_tz()

Other datetime_checkers: chk_date_time()

Examples

# chk_date
chk_date(Sys.Date())
try(chk_date(1))
#> Error in eval(expr, envir) : 
#>   `1` must be a date (non-missing Date scalar).
# vld_date
vld_date(Sys.Date())
#> [1] TRUE
vld_date(Sys.time())
#> [1] FALSE
vld_date(1)
#> [1] FALSE