get_tides: Get tide table for a port and day

Description Usage Arguments Examples

View source: R/get_tides.R

Description

Returns a data.frame with all tidal, for a time period with a specified start date and duration. The returned times are always in the local GMT time for the port (as specified in by the Portuguese National Hydrographic Institute).

Usage

1
2
3
4
5
6
7
get_tides(
  port_id = 19,
  date = Sys.Date(),
  day_range = 1,
  include_moons = FALSE,
  silent = FALSE
)

Arguments

port_id

The id code for the desired port. Use 'port_list()' to see a list of IDs. Defaults to 19, which is Faro-Olhão.

date

The starting date for the wanted tides. Format should be yyyy-mm-dd or yyyy/mm/dd. Accepts class character, Date and POSIXct. Defaults to current date.

day_range

The number of days for which to retrieve information. Defaults to 1 which only provides tides for 'date'

include_moons

Should lunar events be kept in the table? Defaults to FALSE.

silent

Should messages be suppressed? Defaults to FALSE (displays messages).

Examples

1
2
Retrieve the information for the Faro - Olhao port, for 7 days, starting at March 5th of 2020
tides <- get_tides(port_id = 19, date = "2020-03-05", day_range = 7)

MarcioFCMartins/tidytides documentation built on Jan. 27, 2021, 9:47 a.m.