index_arguments.sum: arguments for calculating sum

Description Usage Arguments Examples

View source: R/calc_indices_get_arguments.R

Description

arguments for calculating sum

Usage

1
2
3
4
5
6
7
8
9
## S3 method for class 'sum'
index_arguments(
  climindvis,
  var,
  NAmaxAgg = 20,
  trend = FALSE,
  NAmaxTrend = 20,
  ...
)

Arguments

climindvis

Object of type climindvis as returned by make_object which must contain the variable "var".

var

Variable for which sum should be calculated (tmin/tmax/tavg/prec)

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

1
2
data(object_st) # load example objects
calc_index(object_st,index="sum",aggt="seasonal",selagg=c("JJA","DJF"),var="tmin")

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