index_arguments.txx: arguments for index txx

In Climandes/ClimIndVis: Calculation, verification and visualisation of climate indices

Description

arguments for index txx

Usage

## S3 method for class 'txx'
index_arguments(climindvis, NAmaxAgg = 20, trend = FALSE, NAmaxTrend = 20, ...)

Arguments

climindvis	Object of type climindvis as returned by make_object which must contain the variable maximum temperature (tmax)
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 trend_methods. You can chose to calculate a non-parameteric trend, by setting trend to a character string "MannKendall". This calculates a TheilSen slope and MannKendall test. Default = FALSE.
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%).

Examples

data(object_st) # load example objects
calc_index(object_st,index="txx",aggt="monthly", selagg=c(2:4))

Climandes/ClimIndVis documentation built on Oct. 24, 2021, 10:52 a.m.