Generic-methods-for-spei-objects: Generic methods for 'spei' objects.

Generic-methods-for-spei-objectsR Documentation

Generic methods for spei objects.

Description

Generic methods for extracting information and plotting spei objects.

See print.spei

See print.spei

Usage

## S3 method for class 'spei'
print(x, ...)
## S3 method for class 'spei'
summary(object, ...)
## S3 method for class 'spei'
plot(x, ...)

## S3 method for class 'spei'
summary(object, ...)

## S3 method for class 'spei'
plot(x, ...)

Arguments

x

an object of class spei.

...

additional parameters, not used at present.

object

an object of class spei.

Details

These functions allow extracting information and plotting spei objects. print yields the fitted values, i.e. a time series of SPEI or SPI values. summary reports the function call, the parameters of the PDF used, and the time series of SPEI or SPI values. plot produces a plot of the time series of SPEI or SPI values, with blue and red colors for positive and negative values, respectively. If a reference period was used in the function call it is shown by a shaded area. In the event that NA or Inf values were produced, these are shown by circles.

See print.spei

See print.spei

Author(s)

Santiago Beguería

References

S.M. Vicente-Serrano, S. Beguería, J.I. López-Moreno. 2010. A Multi-scalar drought index sensitive to global warming: The Standardized Precipitation Evapotranspiration Index – SPEI. Journal of Climate 23: 1696, DOI: 10.1175/2009JCLI2909.1.

Examples

# See examples of use in the help page of the spei() function.


sbegueria/SPEI documentation built on July 22, 2023, 6:59 p.m.