chk_tz: Check Time Zone

In chk: Check User-Supplied Function Arguments

Check Time Zone

Description

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

length()

OlsonNames()

is.character()

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

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

Examples

chk_tz("UTC")
try(chk_tz("TCU"))
vld_tz("UTC")
vld_tz("TCU")

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