get_plain_mode: Retrieve the tide events for a specified location

In BigelowLab/maree: maree

Retrieve the tide events for a specified location

Description

Retrieve the tide events for a specified location

Usage

get_plain_mode(
  location = "Portland",
  time = c(Sys.time(), Sys.time() + 4 * (24 * 3600)),
  ofile = tempfile(),
  compress = FALSE,
  app = Sys.which("/opt/bin/tide"),
  utc = TRUE,
  append = FALSE,
  verbose = TRUE
)

Arguments

location	the name of the location
time	2 element vector of POSIXct time to start and stop start <= time < stop. Defaults to [now, now + 4 days]
ofile	character, the output filename. Defaults to tempfile()
compress	logical, if TRUE compress the file. Defaults to TRUE.
app	the name of the application. Defaults to Sys.which("/opt/bin/tide")
utc	logical if TRUE then return values in UTC, otherwise local time
append	logical, if TRUE append to exisiting output file (if any). Otherwise overwrite existing output file.
verbose	logical if TRUE print the command run

Value

list with

• location, the name of the location

• file, the name of the output file

• moon, tibble of moon rise/set, possible with 0 rows

• sun, tibble of sun rise/set, possibly with 0 rows

• tide, tibble of tide height and stage, possibly with 0 rows

BigelowLab/maree documentation built on April 23, 2023, 4:19 p.m.