check_tz: Check Time Zone

In poissonconsulting/dttr: Manipulate Date and Time Objects

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

Examples

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

poissonconsulting/dttr documentation built on Feb. 20, 2021, 12:18 a.m.