ssi: Wrapper function from the SCI package to calculate the...

In obaezvil/SpatIndex: Calculate spatially distributed hydroclimatological indices

Wrapper function from the SCI package to calculate the Standardized Streamflow Index (SSI)

Description

Wrapper function from the SCI package to calculate the Standardized Streamflow Index (SSI)

Usage

ssi(x, scale, ref_start = NULL, ref_end = NULL, distribution)

Arguments

x	Zoo object with one or multiple monthly time series.
scale	Integer value that represents the time scale at which the SSI 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 SSI (one of 'log-Logistic', 'GEV', 'Gamma', and 'PearsonIII'). #'

Value

Standardised Streamflow Index.

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