index_arguments.th_range: arguments for index th_range

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

Description

arguments for index th_range

Usage

## S3 method for class 'th_range'
index_arguments(
  climindvis,
  threshold,
  operator,
  threshold2,
  operator2,
  thvar,
  iformat = "perc",
  NAmaxAgg = 20,
  trend = FALSE,
  NAmaxTrend = 20,
  fyear = FALSE,
  ...
)

Arguments

climindvis	Object of type climindvis as returned by make_object which must contain the variable "thvar".
threshold	Threshold (numerical). Thresholds need to be provided in mm for precipitation and in degrees C for temperature.
operator	One of ">",">=","<","<="
threshold2	Threshold (numerical)
operator2	One of ">",">=","<","<="
thvar	Variable for which days in range should be calculated (tmin/tmax/tavg/prec) by threshold operator thvar operator2 threshold2
iformat	Format for indicator "perc"(default)/"days"
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="th_range",aggt="seasonal",trend=TRUE,
threshold=-5,operator=">=",threshold2 = 5, operator2 = "<=", thvar="tmin")

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