Package 'rtide'

Title: Tide Heights
Description: Calculates tide heights based on tide station harmonics. It includes the harmonics data for 637 US stations. The harmonics data was converted from <https://github.com/poissonconsulting/rtide/blob/main/data-raw/harmonics-dwf-20151227-free.tar.bz2>, NOAA web site data processed by David Flater for 'XTide'. The code to calculate tide heights from the harmonics is based on 'XTide'.
Authors: Joe Thorley [aut] , Luke Miller [aut, cre], Abram Fleishman [aut], Poisson Consulting [cph]
Maintainer: Luke Miller <[email protected]>
License: GPL-3
Version: 0.0.11
Built: 2024-11-21 07:38:24 UTC
Source: https://github.com/millerlp/rtide

Help Index

Brandywine Tide Height Data

Description

High/Low Tide Predictions from https://tidesandcurrents.noaa.gov/tide_predictions.html.

Usage

brandywine

Format

A tbl data frame:

Station

The station name (chr).

DateTime

The date time (time).

MLLW

The tide height in m (dbl).

Harmonics

Description

A object of class tide_harmonics providing tidal harmonic data for US stations.

Usage

harmonics

Format

An object of class tide_harmonics of length 4.

Details

Converted from harmonics-dwf-20151227-free, NOAA web site data processed by David Flater for XTide.

Is tide_harmonics

Description

Tests if object inherits from class tide_harmonics.

Usage

is.tide_harmonics(x)

Arguments

x

The object to test.

Monterey Tide Height Data

Description

High/Low Tide Predictions from https://tidesandcurrents.noaa.gov/tide_predictions.html.

Usage

monterey

Format

A tbl data frame:

Station

The station name (chr).

DateTime

The date time (time).

MLLW

The tide height in m (dbl).

Tide Date Times

Description

Generates sequence of date times.

Usage

tide_datetimes(
  minutes = 60L,
  from = as.Date("2015-01-01"),
  to = as.Date("2015-12-31"),
  tz = "America/Los_Angeles"
)

Arguments

minutes

An integer of the number of minutes between tide heights
from

A Date of the start of the period of interest
to

A Date of the end of the period of interest
tz

A string of the time zone.

Value

A POSIXct vector.

Examples

tide_datetimes()

Tide Height

Description

Calculates tide height at specified stations based on the supplied harmonics object.

Usage

tide_height(
  stations = "Monterey Harbor",
  minutes = 60L,
  from = as.Date("2015-01-01"),
  to = as.Date("2015-01-01"),
  tz = "UTC",
  harmonics = rtide::harmonics
)

Arguments

stations

A character vector of stations to match - treated as regular expressions.
minutes

An integer of the number of minutes between tide heights
from

A Date of the start of the period of interest
to

A Date of the end of the period of interest
tz

A string of the time zone.
harmonics

The harmonics object.

Value

A data frame of the tide heights in m by the number of minutes for each station from from to to.

Tide Height Data

Description

Calculates tide height at specified stations at particular date times based on the supplied harmonics object.

Usage

tide_height_data(data, harmonics = rtide::harmonics)

Arguments

data

A data frame with the columns Station and DateTime.
harmonics

The harmonics object.

Value

A data frame of the tide heights in m.

Tide Slack Data

Description

Determines the closest slack tide for specified stations at particular date times based on the supplied harmonics object.

Usage

tide_slack_data(data, harmonics = rtide::harmonics)

Arguments

data

A data frame with the columns Station and DateTime.
harmonics

The harmonics object.

Value

A data frame of the slack tide date times and heights in m.

Tide Stations

Description

Gets vector of matching stations.

Usage

tide_stations(stations = ".*", harmonics = rtide::harmonics)

Arguments

stations

A character vector of stations to match - treated as regular expressions.
harmonics

The harmonics object.