extremalindex: Extemal Index

View source: R/dependence.R

extremalindexR Documentation

Extemal Index

Description

Estimate the extremal index.

Usage

extremalindex(x, threshold, method = c("intervals", "runs"), run.length = 1,
    na.action = na.fail, ...)

## S3 method for class 'extremalindex'
ci(x, alpha = 0.05, R = 502, return.samples = FALSE, ...)

## S3 method for class 'extremalindex'
print(x, ...)

Arguments

x

A data vector.

ci and print: output from extremalindex.

threshold

numeric of length one or the length of x giving the value above which (non-inclusive) the extremal index should be calculated.

method

character string stating which method should be used to estimate the extremal index.

run.length

For runs declustering only, an integer giving the number of threshold deficits to be considered as starting a new cluster.

na.action

function to handle missing values.

alpha

number between zero and one giving the (1 - alpha) * 100 percent confidence level. For example, alpha = 0.05 corresponds to 95 percent confidence; alpha is the significance level (or probability of type I errors) for hypothesis tests based on the CIs.

R

Number of replicate samples to use in the bootstrap procedure.

return.samples

logical; if TRUE, the bootstrap replicate samples will be returned instead of CIs. This is useful, for example, if one wishes to find CIs using a better method than the one used here (percentile method).

...

optional arguments to decluster. Not used by ci or print.

Details

The extremal index is a useful indicator of how much clustering of exceedances of a threshold occurs in the limit of the distribution. For independent data, theta = 1, (though the converse is does not hold) and if theta < 1, then there is some dependency (clustering) in the limit.

There are many possible estimators of the extremal index. The ones used here are runs declustering (e.g., Coles, 2001 sec. 5.3.2) and the intervals estimator described in Ferro and Segers (2003). It is unbiased in the mean and can be used to estimate the number of clusters, which is also done by this function.

Value

A numeric vector of length three and class “extremalindex” is returned giving the estimated extremal index, the number of clusters and the run length. Also has attributes including:

cluster

the resulting clusters.

method

Same as argument above.

data.name

character vector giving the name of the data used, and possibly the data frame or matrix and column name, if applicable.

data.call

character string giving the actual argument passed in for x. May be the same as data.name.

call

the function call.

na.action

function used for handling missing values. Same as argument above.

threshold

the threshold used.

Author(s)

Eric Gilleland

References

Coles, S. (2001) An introduction to statistical modeling of extreme values, London, U.K.: Springer-Verlag, 208 pp.

Ferro, C. A. T. and Segers, J. (2003). Inference for clusters of extreme values. Journal of the Royal Statistical Society B, 65, 545–556.

See Also

decluster, fevd

Examples

data(Fort)

extremalindex(Fort$Prec, 0.395, method="runs", run.length=9, blocks=Fort$year)

## Not run: 
tmp <- extremalindex(Fort$Prec, 0.395, method="runs", run.length=9, blocks=Fort$year)
tmp
ci(tmp)

tmp <- extremalindex(Fort$Prec, 0.395, method="intervals", run.length=9, blocks=Fort$year)
tmp
ci(tmp)


## End(Not run)

extRemes documentation built on Nov. 19, 2022, 1:07 a.m.