chk_date: Check Date

In chk: Check User-Supplied Function Arguments

Check Date

Description

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

inherits()

length()

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))
# vld_date
vld_date(Sys.Date())
vld_date(Sys.time())
vld_date(1)

chk documentation built on April 3, 2025, 8:50 p.m.