TideCurves (version 0.0.5)

TideCurve: Computes tide curves

Description

Takes a data frame as input with three columns (see example dataset) and returns a tide curve. Internally the analysis is carried out in lunar days. One mean lunar day lasts 1.0350501 mean solar days. Therefore the analysis time period should start one lunar day after the first observation and end one lunar day before the last observation.

Usage

TideCurve(
  dataInput,
  otz = 1,
  km = -1,
  mindt = 30,
  asdate,
  astime,
  aedate,
  aetime,
  ssdate,
  sstime,
  sedate,
  setime
)

Arguments

dataInput

A data frame with the columns observation_date, observation_time and height. See attached data for correct formats.

otz

The time zone of the observations

km

The number of nodes between two consecutive mean moon transits. Shall be less or equal to: round(1440 [min] / time step [min]) Example: Time step 5 min: Use km = 288 or even smaller. Leave on default (km = -1) and supply mindt, when unsure.

mindt

Observation time step in [min]. Default is 30.

asdate

A string indication the date you want the analysis to start with. Format: "yyyy/mm/dd".

astime

A string indicating the time you want the analysis to start with. Format: "hh:mm:ss"

aedate

A string indication the date you want the analysis to end with. Format: "yyyy/mm/dd".

aetime

A string indicating the time you want the analysis to end with. Format: "hh:mm:ss"

ssdate

Synthesis start date. This indicates the date you want your tide curve to start with. Format: See above

sstime

Synthesis start time. The starting time for your tide table. Format: See above

sedate

Synthesis end date. Format: See above

setime

Synthesis end time. Format: See above

Value

Returns a list with elements of the analysis, fitting and the tidal curve for given data

synthesis.lunar

The lunar synthesis data as a data.table object in UTC

data.matrix

The data needed for analysis

tide.curve

The solar tide curve as a data.table object (provided time zone)

lm.coeff

Coefficients for the km fitted linear models used in the synthesis as a list of 1-row matrices

diff.analyse

Time in days spanning the analysis

References

Godin, Gabriel (1972) The Analysis of Tides. Toronto, 264pp

10.5194/os-15-1363-2019

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

Examples

# NOT RUN {
TideCurve(dataInput = tideObservation, asdate = "2015/12/06",
             astime = "00:00:00",      aedate = "2015/12/31",
             aetime = "23:30:00",      ssdate = "2015/12/17",
             sstime = "00:00:00",      sedate = "2015/12/31",
             setime = "23:30:00")
# }
# NOT RUN {
# }