calculate_index.spi_forecast: default index function for climindvis objects
In Climandes/ClimIndVis: Calculation, verification and visualisation of climate indices
Description
Usage
Arguments
Value
Details
References
See Also
View source: R/calc_index_spei.R
Description
default index function for climindvis objects
Usage
1
2
## S3 method for class 'spi_forecast'
calculate_index(climindvis, aggt, ...)
Arguments
climindvis
Climindvis object generated using the function make_object.
forecast
Climindvis object with forecast data generated using the function make_object
args
List of arguments for calculation of index. Arguments depend on type of index, for more information see documentation of calculate_index
Value
The function returns a climindvis_index object with an additonal entry <index_fcst>.
Details
The SPI calculation is based on the SCI package from Lukas Gudmundsson & James Stagge. For integrating forecasts into the SPI plot, the timeseries of forecast and historical data are checked for the overlapping period. For this period a mean
References
Stagee, J.H. ; Tallaksen, L.M.; Gudmundsson, L.; van Loon, A.; Stahl, K.: Candidate Distributions for Climatological Drought Indices (SPI and SPEI), 2015, International Journal of Climatology, 35, 4027-4040, doi:10.1002/joc.4267.
See Also
make_object
Other calculate_index:
calculate_index.climindvis()
Climandes/ClimIndVis documentation built on Oct. 24, 2021, 10:52 a.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.
Description Usage Arguments Value Details References See Also
View source: R/calc_index_spei.R
Description
default index function for climindvis objects
Usage
1 2 | ## S3 method for class 'spi_forecast'
calculate_index(climindvis, aggt, ...)
|
Arguments
climindvis |
Climindvis object generated using the function make_object. |
forecast |
Climindvis object with forecast data generated using the function make_object |
args |
List of arguments for calculation of index. Arguments depend on type of index, for more information see documentation of calculate_index |
Value
The function returns a climindvis_index object with an additonal entry <index_fcst>.
Details
The SPI calculation is based on the SCI package from Lukas Gudmundsson & James Stagge. For integrating forecasts into the SPI plot, the timeseries of forecast and historical data are checked for the overlapping period. For this period a mean
References
Stagee, J.H. ; Tallaksen, L.M.; Gudmundsson, L.; van Loon, A.; Stahl, K.: Candidate Distributions for Climatological Drought Indices (SPI and SPEI), 2015, International Journal of Climatology, 35, 4027-4040, doi:10.1002/joc.4267.
See Also
make_object
Other calculate_index:
calculate_index.climindvis()
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.