View source: R/calc_indices_get_arguments.R
index_arguments.rainy_season_start | R Documentation |
arguments for index rainy_season_start
## S3 method for class 'rainy_season_start'
index_arguments(
climindvis,
rs_method,
days,
th,
th1 = 25,
th2 = 20,
dd_th = 1,
nval = NA,
mdays,
mcdd,
trend = FALSE,
NAmaxTrend = 20,
NAdays = 0,
...
)
climindvis |
Object of type climindvis as returned by |
days |
Number of consecutive days of which precipitation sum is higher than threshold <<th>> |
th |
Threshold for precipitation sum of <<days>> consecutive days in mm |
dd_th |
Dry day threshold |
nval |
Value which is returned if criteria for start of rainy season are not met, default=NA. Other values can be set to distinguish between years where data is NA and years where criteria of index are not met |
mdays |
Number of days to check for <<mcdd>> |
mcdd |
Maximum consecutive dry days in the next <<mdays>> days |
trend |
Logial (or character). Calculates trends with a predefined method for the chosen index. For information on default method, see |
NAmaxTrend |
Maximum number of years in time series of index which are missing values. Value between 0 (=0%); no years with missing values allowed) and 100 (=100%); all years can be missing values). If exceeded, the trend is set to NA for the respective grid point/station. Note that the value is relative to the length of the time series. Default = 20 (20%). |
NAdays |
Number of NA days allowed per decade for index <<sos>>. Default=0. |
rs_method: |
method for calculation of index (further indicator arguments for each rs_method are given in brackets and defined below, arguments without default that have to be provided are in bold font ):
|
In this case of choosing <<sos>> decades are calculatet starting from start_date defined in the aggregtion. The returned day is the last day of the decade, e.g. if the criterion is met in the second decade, the return value would be 20. The precipitation per decade is calculated by the mean(prec)*10 in order to avoid the influence of missing values. By using the parameter NAdays, the number of allowed missing values per decade can be defined. If the onset criteria are not met the value for the given year is set to NA.
data(object_st) # load example objects
calc_index(object_st,index="rainy_season_start",aggt="dates",start_days="0000-08-01",end_days="0000-03-01",rs_method="gurgiser")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.