chk: chk_date_time – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

chk

chk_date_time

Check Date Time

Description

Checks if non-missing POSIXct scalar using

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

Usage

chk_date_time(x, x_name = NULL)

chk_datetime(x, x_name = NULL)

vld_date_time(x)

vld_datetime(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.

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

Functions

chk_datetime: Check Date Time (Deprecated)
vld_date_time: Validate Date Time
vld_datetime: Validate Date Time (Deprecated)

Examples

# chk_date_time
chk_date_time(as.POSIXct("2001-01-02"))
try(chk_date_time(1))
# vld_date_time
vld_date_time(as.POSIXct("2001-01-02"))
vld_date_time(Sys.time())
vld_date_time(1)
vld_date_time("2001-01-02")
vld_date_time(c(Sys.time(), Sys.time()))

chk

Check User-Supplied Function Arguments

v0.5.1

MIT + file LICENSE

Authors

Joe Thorley [aut, cre] (<https://orcid.org/0000-0002-7683-4592>), Kirill Müller [aut] (<https://orcid.org/0000-0002-1416-3412>), Ayla Pearson [ctb] (<https://orcid.org/0000-0001-7388-1222>), Poisson Consulting [cph, fnd]

Initial release