Description Usage Arguments NOTE Examples
View source: R/calc_indices_get_arguments.R
arguments for index cwd
1 2 3 4 5 6 7 8 9 10 11 | ## S3 method for class 'cwd'
index_arguments(
climindvis,
NAmaxAgg = 20,
trend = FALSE,
NAmaxTrend = 20,
dd_threshold = 1,
spells_span_agg = FALSE,
fyear = FALSE,
...
)
|
climindvis |
Object of type climindvis as returned by |
NAmaxAgg |
Maximum number of missing values in daily data of each aggregation period (e.g. in all January values for the whole time series). Value between 0 (=0%; no missing values allowed) and 100 (=100%; all values can be missing values). If the number of missing values is higher than NAmaxAgg the index value for the respective grid point/station is set to NA. Default = 20 (20%). |
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%). |
dd_threshold |
Precipitation threshold for dry days in mm. Default = 1 |
spells_span_agg |
Logical.Should spells starting before the chosen aggregation period be considered? Default=FALSE. |
if spells_span_agg=TRUE spells starting before the chosen aggregation period are considered. Spells starting in the chosen period and lasting until the next period however are not accounted for. Therefore it is not recommended to use this function for very short time periods as the returned results may not be very plausible. For years where all values within the chosen aggregation period are dry days, the function returns NA.
1 2 | data(object_st) # load example objects
calc_index(object_st,index="cwd",aggt="annual")
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.