Newer
Older
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#### Sectoral Indicators for Climate Services Based on Sub-Seasonal to Decadal Climate Predictions
## Description
Set of generalised tools for the flexible computation of climate related indicators defined by the user. Each method represents a specific mathematical approach which is combined with the possibility to select an arbitrary time period to define the indicator. This enables a wide range of possibilities to tailor the most suitable indicator for each particular climate service application (agriculture, food security, energy, water management…). This package is intended for sub-seasonal, seasonal and decadal climate predictions, but its methods are also applicable to other time-scales, provided the dimensional structure of the input is maintained. Additionally, the outputs of the functions in this package are compatible with CSTools.
## Functions and documentation
To learn how to use the package see:
- [**Agricultural Indicators**](https://CRAN.R-project.org/package=CSIndicators/vignettes/AgriculturalIndicators.html)
- [**Wind Energy Indicators**](https://CRAN.R-project.org/package=CSIndicators/vignettes/EnergyIndicators.html)
Functions documentation can be found [here](https://CRAN.R-project.org/package=CSIndicators/CSIndicators.pdf)
| Function | CST version | Indicators |
|--------------------------------|------------------------------------|---------------------------------|
|PeriodMean |CST_PeriodMean |GST, SprTX, DTR |
|PeriodAccumulation |CST_PeriodAccumulation |SprR, HarR, PRCPTOT |
|AccumulationExceedingThreshold |CST_AccumulationExceedingThreshold |GDD, R95pTOT, R99pTOT |
|TotalTimeExceedingThreshold |CST_TotalTimeExceedingThreshold |SU35, SU, FD, ID, TR, R10mm, Rnmm|
|TotalSpellTimeExceedingThreshold|CST_TotalSpellTimeExceedingThreshold|WSDI, CSDI |
|WindCapacityFactor |CST_WindCapacityFactor |Wind Capacity Factor |
|WindPowerDensity |CST_WindPowerDensity |Wind Power Density |
| Auxiliar function | CST version |
|-------------------|----------------------|
|AbsToProbs |CST_AbsToProbs |
|QThreshold |CST_QThreshold |
|Threshold |CST_Threshold |
|MergeRefToExp |CST_MergeRefToExp |
|SelectPeriodOnData |CST_SelectPeriodOnData|
|SelectPeriodOnDates| |
*Note: the CST version uses 's2dv_cube' objects as inputs and outputs while the former version uses multidimensional arrays with named dimensions as inputs and outputs*
*Note: All functions computing indicators allows to subset a time period if required, although this temporal subsetting can also be done with funcitons `SelectPeriodOnData` in a separated step.*
### How to contribute
1. Open an issue to ask for help or describe a function to be integrated
2. Agree with maintainers (@ngonzal2, @rmarcos and @nperez) on the requirements
3. Create a new branch from master with a meaningful name
4. Once the development is finished, open a merge request to merge the branch on master
*Note: Remember to work with multidimensionals arrays with named dimensions when possible and use multiApply (https://earth.bsc.es/gitlab/ces/multiApply)*
### Add a function
To add a new function in this R package, follow this considerations:
1. Each function exposed to the users should be in separate files in the R folder
2. The name of the function should match the name of the file (e.g.: `Function()` included in file **Function.R**
3. The documentation should be in roxygen2 format as a header of the function
4. Once, the function and the documentation is finished, run the command `devtools::document()` in your R terminal to automatically generate the **Function.Rd** file
5. Remember to use R 3.6.1 when doing the development
6. Code format: include spaces between operators (e.g. +, -, &), before { and after ','. The maximum length of lines is of 100 characters (hard limit 80 characters). Number of indentation spaces is 2.
7. Functions computing Climate indicators should include a temporal subsetting option. Use the already existing functions to adapt your code.