Learn R Programming

Tides (version 2.1)

IT: Inundation time

Description

Calculate inundation times, i.e. time intervals for which water level h > h0. Care must be taken when there are gaps (long time periods for which there is no data )in the time series. Either the erroneous values have to removed manually, or a wrapper making use of the function gapsts can be used.

Usage

IT(h, h0, hoffset = 0, dtMax = 15, unit = "mins")

Arguments

h

Water level time series. data frame with time and h column

h0

Reference level, either single valued or vector with same length as h

hoffset

Offset level to cope with small fluctuations due to rain, ripples. h <= h0 + hoffset is considered dry; h> h0+hoffset is considered wet

dtMax

Maximum time interval in continuous water level series. Larger time intervals are considered gaps

unit

Unit of dtMax.

Value

a list containing:

  • IT Data frame with start time (t1), end time (t2) and duration (dt, unit = unit) of inundation

  • DT Data frame with start time (t1), end time (t2) and duration (dt, unit = unit) of dry time