rc_unc.class

An S4 class to represent the Uncertainty of the Return Curve estimates

internal

Estimates the p-probability return curve proposed by Murphy-Barltrop et al. (2023) <doi:10.1002/env.2797>. Implements pointwise and smooth estimation of the angular dependence function introduced by Wadsworth and Tawn (2013) <doi:10.3150/12-BEJ471>.

Lídia André

ReturnCurves

Estimation of Return Curves

Callum Murphy-Barltrop

rc_unc.class function

<dl>
<dt><code>retcurve</code></dt>
<dd>An S4 object of class <code>rc_est.class</code>.</dd></dl>
<dt><code>blocksize</code></dt>
<dd>Size of the blocks for the block bootstrap procedure. If <code>1</code> (default), then a standard bootstrap approach is applied.</dd>
<dt><code>nboot</code></dt>
<dd>Number of bootstrap samples to be taken. Default is <code>250</code> samples.</dd>
<dt><code>nangles</code></dt>
<dd>Number of angles mm in the interval (0, /2) MurphyBarltropetal2023ReturnCurves. Default is <code>150</code> angles.</dd>
<dt><code>alpha</code></dt>
<dd>Significance level to compute the (1-)% confidence intervals. Default is <code>0.05</code>.</dd>
<dt><code>unc</code></dt>
<dd>A list containing the median and mean estimates of the Return Curve, and the lower and upper bound of the confidence interval.</dd>

Slots

An S4 class to represent the Uncertainty of the Return Curve estimates — rc_unc.class

<dl>
<dt><code>retcurve</code></dt>
<dd>An S4 object of class <code>rc_est.class</code>.</dd>


<dt><code>blocksize</code></dt>
<dd>Size of the blocks for the block bootstrap procedure. If <code>1</code> (default), then a standard bootstrap approach is applied.</dd>


<dt><code>nboot</code></dt>
<dd>Number of bootstrap samples to be taken. Default is <code>250</code> samples.</dd>


<dt><code>nangles</code></dt>
<dd>Number of angles mm in the interval (0, /2) MurphyBarltropetal2023ReturnCurves. Default is <code>150</code> angles.</dd>


<dt><code>alpha</code></dt>
<dd>Significance level to compute the (1-)% confidence intervals. Default is <code>0.05</code>.</dd>


<dt><code>unc</code></dt>
<dd>A list containing the median and mean estimates of the Return Curve, and the lower and upper bound of the confidence interval.</dd>


</dl>

rc_unc.class: An S4 class to represent the Uncertainty of the Return Curve estimates

Description

Usage

Arguments

Slots