check_tzone: Check TimeZone

Description Usage Arguments Value Examples

Description

Checks an objects tzone attribute.

Usage

1
check_tzone(x, tzone = "UTC", x_name = substitute(x), error = TRUE)

Arguments

x

The object to check.

tzone

A string of the time zone.

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

Examples

1
2
3
check_tzone(Sys.Date(), error = FALSE)
x <- as.POSIXct("2000-01-02 03:04:55", tz = "Etc/GMT+8")
check_tzone(x, tzone = "PST8PDT", error = FALSE)

checkr documentation built on May 1, 2019, 6:59 p.m.