check_tz: Check Time Zone

In dttr2: Manipulate Date, POSIXct and hms Vectors

Check Time Zone

Description

Checks an object's time zone as returned by dtt_tz().

Usage

check_tz(x, tz = dtt_tz(x), x_name = substitute(x), error = TRUE)

Arguments

x	The object to check.
tz	A string of the time zone to check that x's matches.
x_name	A string of the name of the object.
error	A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.

Value

An invisible copy of x (if it doesn't throw an error).

See Also

dtt_tz()

Other check: chk_time()

Examples

check_tz(Sys.time(), "UTC", error = FALSE)

dttr2 documentation built on Sept. 26, 2024, 1:06 a.m.