get_tz: Access station timezone information, either as an offset from...

Description Usage Arguments Value See Also Examples

View source: R/get_availability.R

Description

Consults the NOAA metadata API for your selected station, and queries it for information on the station's (standard time) timezone offset from UTC.

Usage

1
get_tz(.station, .type = c("offset", "string"))

Arguments

.station

Code for NOAA tide station.

.type

Either 'offset' for an integer value offset from UTC, or

Value

Either an integer for .type = 'offset') or a string (‘.type = ’string')of specifying a time zone offset, of the form 'Etc/GMT+X', where X is an integer. This string form is likely to only work correctly for the western hemisphere, and has not been tested elsewhere. U.S Eastern Standard Time is offset == -5, or 'Etc/GMT+5'

See Also

Other station information access functions: get_availability(), get_datums(), get_epoch(), get_hat(), get_sl_trend()

Examples

1
2
3
Providence_station <- 8454000  # Providence, Rhode Island
get_tz(Providence_station)
get_tz(Providence_station, .type = 'string')

ccb60/SLRSIM documentation built on Jan. 21, 2022, 1:31 a.m.