dot-zspi: Utils function to calculate the boolean SPI (zSPI) to be used...
In obaezvil/SpatIndex: Calculate spatially distributed hydroclimatological indices
.zspi R Documentation
Utils function to calculate the boolean SPI (zSPI) to be used in the CDI
Description
Utils function to calculate the boolean SPI (zSPI) to be used in the CDI
Usage
.zspi(SPI1_data, SPI3_data, threshold_spi1, threshold_spi3)
Arguments
SPI1_data
'SpatRaster' object that contains the SPI-1 data that will be used to calculate the zSPI.
This 'SpatRaster' must include the time that corresponds to the dates of the respective layers. They can be set with the function time
of the terra package.
SPI3_data
'SpatRaster' object that contains the SPI-3 data that will be used to calculate the zSPI.
This 'SpatRaster' must include the time that corresponds to the dates of the respective layers. They can be set with the function time
of the terra package.
threshold_spi1
Threshold to construct the Boolean layer for SPI-1. Set to -2 by default.
threshold_spi3
Threshold to construct the Boolean layer for SPI-3. Set to -1 by default.
Value
Returns the zSPI
obaezvil/SpatIndex documentation built on Aug. 9, 2024, 3:42 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| .zspi | R Documentation |
Utils function to calculate the boolean SPI (zSPI) to be used in the CDI
Description
Utils function to calculate the boolean SPI (zSPI) to be used in the CDI
Usage
.zspi(SPI1_data, SPI3_data, threshold_spi1, threshold_spi3)
Arguments
SPI1_data |
'SpatRaster' object that contains the SPI-1 data that will be used to calculate the zSPI. This 'SpatRaster' must include the time that corresponds to the dates of the respective layers. They can be set with the function time of the terra package. |
SPI3_data |
'SpatRaster' object that contains the SPI-3 data that will be used to calculate the zSPI. This 'SpatRaster' must include the time that corresponds to the dates of the respective layers. They can be set with the function time of the terra package. |
threshold_spi1 |
Threshold to construct the Boolean layer for SPI-1. Set to -2 by default. |
threshold_spi3 |
Threshold to construct the Boolean layer for SPI-3. Set to -1 by default. |
Value
Returns the zSPI
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.