TideCurves (version 0.0.5)

BuildTC: Builds a TideCurve model

Description

Builds a TideCurve model of class "tidecurve".

Usage

BuildTC(
  dataInput = NULL,
  otz = 1,
  astime,
  asdate,
  aedate,
  aetime,
  km = -1,
  mindt = 30,
  keep_data = FALSE
)

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

astime

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

asdate

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

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".

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.

keep_data

Indicating whether you want to keep the data for computing residuals later. Default is FALSE which keeps the model footprint small.

Value

A model of class tidecurve, which is a list.

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

# NOT RUN {
# }
# NOT RUN {
BuildTC(dataInput = tideObservation, asdate = "2015/12/06",
             astime = "00:00:00", aedate = "2015/12/31",
             aetime = "23:30:00")
# }
# NOT RUN {
# }