dot-spi.spei: Utils function to calculate the SPI (SPEI package)

In obaezvil/SpatIndex: Calculate spatially distributed hydroclimatological indices

Utils function to calculate the SPI (SPEI package)

Description

Utils function to calculate the SPI (SPEI package)

Usage

.spi.spei(x, dates, scale, ref_start, ref_end, distribution, fit, ...)

Arguments

x	Numerical vector.
dates	Vector of dates that is extracted from the 'SpatRaster' in the 'spatial_spi' function.
scale	Integer value that represents the time scale at which the SPI will be computed.
ref_start	optional value that represents the starting point of the reference period used for computing the index. The date should be introduced as '%Y-%m'. For example: "1989-02". The default is NULL, which indicates that the first layer in the 'SpatRaster' will be used as starting point.
ref_end	Optional value that represents the ending point of the reference period used for computing the index. The date should be introduced as '%Y-%m'. For example: "1989-02". The default is NULL, which indicates that the last layer in the 'SpatRaster' will be used as ending point.
distribution	Optional value indicating the name of the distribution function to be used for computing the SPI (one of 'log-Logistic', 'Gamma' and 'PearsonIII'). Defaults to 'Gamma' for SPI.
fit	Optional value indicating the name of the method used for computing the distribution function parameters (one of 'ub-pwm', 'pp-pwm' and 'max-lik'). Defaults to 'ub-pwm'.
...	Additional variables that can be used for the 'spi' function of the SPEI package.

obaezvil/SpatIndex documentation built on Aug. 9, 2024, 3:42 p.m.