Check Time Zone — chk_tz • chk

Checks if non-missing valid scalar timezone using

is.character(x) && length(x) == 1L && !anyNA(x) && x %in% OlsonNames()

Usage

chk_tz(x, x_name = NULL)

vld_tz(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_tz(): Validate Time Zone

See also

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

Examples

chk_tz("UTC")
try(chk_tz("TCU"))
#> Error in eval(expr, envir) : 
#>   `"TCU"` must be a tz (non-missing scalar character of a recognized timezone).
vld_tz("UTC")
#> [1] TRUE
vld_tz("TCU")
#> [1] FALSE