Skip to contents

Check Date Time

Source: R/chk-datetime.R
chk_date_time.Rd

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 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

  • chk_datetime(): Check Date Time (Deprecated)

    [Deprecated]

  • vld_date_time(): Validate Date Time

  • vld_datetime(): Validate Date Time (Deprecated)

    [Deprecated]

See also

Other chk_scalars: chk_date(), chk_number(), chk_scalar(), chk_string(), chk_tz(), chk_whole_number()

Examples

# chk_date_time
chk_date_time(as.POSIXct("2001-01-02"))
try(chk_date_time(1))
#> Error in eval(expr, envir, enclos) : 
#>   `1` must be a date time (non-missing POSIXct scalar).
# vld_date_time
vld_date_time(as.POSIXct("2001-01-02"))
#> [1] TRUE
vld_date_time(Sys.time())
#> [1] TRUE
vld_date_time(1)
#> [1] FALSE
vld_date_time("2001-01-02")
#> [1] FALSE
vld_date_time(c(Sys.time(), Sys.time()))
#> [1] FALSE