proto_event3

An internal function that detects the events according to the heatwave
definition, and joins across the gaps if desired. This is an update of
<code>detect_event</code> and is made entirely within data.table to
benefit from the speed improvements.

internal

The different methods for defining, detecting, and categorising the extreme events
known as heatwaves or cold-spells, as first proposed in Hobday et al. (2016) <doi: 10.1016/j.pocean.2015.12.014>
and Hobday et al. (2018) <https://www.jstor.org/stable/26542662>. The functions in this package work on both air
and water temperature data. These detection algorithms may be used on non-temperature data as well.

Robert W. Schlegel

heatwaveR

Detect Heatwaves and Cold-Spells

Albertus J. Smit

proto_event3 function

<dl><dt>p_series</dt>
<dd>A data.table of the correct dimensions received
from <code>detect_event3</code> within which this runs.</dd>
<dt>criterion_column</dt>
<dd>The column to use for the detection of events.</dd>
<dt>minDuration</dt>
<dd>Minimum duration for acceptance of detected events.</dd>
<dt>joinAcrossGaps</dt>
<dd>This logic gate tells this internal function if
it should connect events across the <code>maxGap</code> (see below). The
default it inherits is <code>TRUE</code>.</dd>
<dt>maxGap</dt>
<dd>This is the number of rows (days) across which distinct
events will be combined into one event if <code>joinAcrossGaps = TRUE</code>.</dd></dl>

Arguments

Albertus J. Smit, Robert W. Schlegel

Author

Detect proto-events based on a chosen criterion (column). — proto_event3

<dl>

<dt>p_series</dt>
<dd>A data.table of the correct dimensions received
from <code>detect_event3</code> within which this runs.</dd>


<dt>criterion_column</dt>
<dd>The column to use for the detection of events.</dd>


<dt>minDuration</dt>
<dd>Minimum duration for acceptance of detected events.</dd>


<dt>joinAcrossGaps</dt>
<dd>This logic gate tells this internal function if
it should connect events across the <code>maxGap</code> (see below). The
default it inherits is <code>TRUE</code>.</dd>


<dt>maxGap</dt>
<dd>This is the number of rows (days) across which distinct
events will be combined into one event if <code>joinAcrossGaps = TRUE</code>.</dd>

</dl>

proto_event3: Detect proto-events based on a chosen criterion (column).

Description

Usage

Value

Arguments

Author