get_hat: Retrieve the value of the Highest Astronomical Tide (HAT)

In ccb60/SLRSIM: Tools to Analyse Sea Level Rise

Description

Retrieve the value of the Highest Astronomical Tide (HAT)

Usage

get_hat(
  .station,
  .units = "metric",
  .datum = c("MSL", "STND", "MHHW", "MHW", "DTL", "MTL", "MLW", "MLLW", "NAVD88")
)

Arguments

.station	A number or string specifying the NOAA station for which to retreive metadata. A list of NOAA stations is available at https://tidesandcurrents.noaa.gov/stations.html?type=Water+Levels. A user-friendly map interface is available here; https://tidesandcurrents.noaa.gov/map/index.html?type=TidePredictions.
.units	Should values be returned in metric (default) or english units?
.datum	The base datum against which to reference HAT. Defaults to MSL, with a warning.

Value

A decimal value, representing the HAT value at the selected station.

See Also

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

Examples

# Retrieve HAT for Portland, Maine
portland_id <- 8418150
get_hat(portland_id)                   # 2.134, with a warning
get_hat(portland_id, .datum = 'MSL')    # 2.134, no warning
get_hat(portland_id, .datum = 'MLLW')   # 3.64

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