In poissonconsulting/rtide: Tide Heights

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-"
)

rtide

Introduction

rtide is an R package to calculate tide heights based on tide station harmonics.

It includes the harmonics data for r length(rtide::tide_stations()) US stations.

Installation

To install the latest release from CRAN

install.packages("rtide")

To install the developmental version from GitHub

# install.packages("pak")
pak::pak("millerlp/rtide")

Utilisation

library(tibble)
library(rtide)

data <- rtide::tide_height(
  "Monterey Harbor",
  from = as.Date("2016-07-13"), to = as.Date("2016-07-15"),
  minutes = 10L, tz = "America/Los_Angeles"
)

print(data)

library(ggplot2)
library(scales)

ggplot(data = data, aes(x = DateTime, y = TideHeight)) +
  geom_line() +
  scale_x_datetime(
    name = "Date",
    labels = date_format("%d %b %Y", tz = "America/Los_Angeles")
  ) +
  scale_y_continuous(name = "Tide Height (m)") +
  ggtitle("Monterey Harbour")

Shiny

Tide heights can be also obtained using rtide through a shiny interface developed by Seb Dalgarno.

Contribution

Please report any issues.

Pull requests are always welcome.

Inspiration

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.

poissonconsulting/rtide documentation built on Jan. 18, 2025, 8:10 p.m.