BuildTT: Builds a TideTable model

Description Usage Arguments Value References Examples

View source: R/BuildTT.R

Description

Builds a TideTable model of class "tidetable".

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
BuildTT(
  dataInput,
  otz = 1,
  asdate,
  astime,
  aedate,
  aetime,
  hwi = "99:99",
  sharp_hwi = TRUE
)

Arguments

dataInput

the data frame with observation date, observation time and height.

otz

time zone of the observations. Default is 1 (UTC + 1)

asdate

The start date.Format: "yyyy/mm/dd"

astime

The start time. Format: "hh:mm:ss"

aedate

The end date. Format: "yyyy/mm/dd"

aetime

The end time. Format: "hh:mm:ss"

hwi

The high water interval. Format: "hh::mm"

sharp_hwi

should the hwi computation be sharp? Default is TRUE

Value

Returns a object of class "tidetable" which contains following elements:

fitting.coeff

Coefficients for the eight fitted linear models used in the synthesis

diff.analyse

Time in days spanning the analysis

omega_t

Return value of FindOmega()

tm24

Internal constant

tplus

Internal constant

tmhwi

Mean high water interval

References

https://www.bsh.de/DE/PUBLIKATIONEN/_Anlagen/Downloads/Meer_und_Umwelt/Berichte-des-BSH/Berichte-des-BSH_50_de.pdf?__blob=publicationFile&v=13/

https://doi.org/10.5194/os-15-1363-2019

Examples

1
2
BuildTT(dataInput = observation, asdate = "1991/01/01", 
astime ="12:00:00", aedate = "1992/01/01", aetime = "12:00:00")

TideTables documentation built on Dec. 16, 2020, 1:06 a.m.