block.xts: Blocking data

In theGreatWhiteShark/climex: Estimating Extreme Events in Climatic Time Series (using Data of the DWD)

Blocking data

Description

Separates the input into blocks of equal size and returns the maximum or minimum of the block as result.

Usage

## S3 method for class 'xts'
block(x, block.number = NULL, block.length = NULL,
  extreme.type = c("max", "min"), mc.cores = NULL)

Arguments

x	An object of class xts.
block.number	Specifies the number of blocks the input data is going to be separated in. Default = NULL.
block.length	Length of the blocks. For the sake of simplicity the last block is not forced to match the length of the other plots. Default = NULL.
extreme.type	String specifying whether the maxima ("max") or minima ("min") of each block should be extracted. Default: "max".
mc.cores	A numerical input specifying the number of cores to use for the multi core application of the function (see detectCores). This functionality is only available if the input is a list of different objects. If NULL, the function will be calculated classically with only one core. Default = NULL.

Details

If both the block.number and block.length arguments are NULL, the data will be split into annual blocks. If not, the size of a block is determined by the block.length argument or calculated via the block.number argument if the previous one is set to NULL. For calculating the mean of the blocks, please have a look at the ave function.

Value

Same class as the input.

Author(s)

Philipp Mueller

See Also

Other extremes: block.list, block, decluster.list, decluster.xts, decluster, extremal.index, gev.density, gpd.density, qevd, return.level.climex.fit.gev, return.level.climex.fit.gpd, return.level.list, return.level.numeric, return.level, revd, rlevd, threshold.list, threshold.xts, threshold, upper.limit.climex.fit.gev, upper.limit.climex.fit.gpd, upper.limit.list, upper.limit.numeric, upper.limit

Other extremes: block.list, block, decluster.list, decluster.xts, decluster, extremal.index, gev.density, gpd.density, qevd, return.level.climex.fit.gev, return.level.climex.fit.gpd, return.level.list, return.level.numeric, return.level, revd, rlevd, threshold.list, threshold.xts, threshold, upper.limit.climex.fit.gev, upper.limit.climex.fit.gpd, upper.limit.list, upper.limit.numeric, upper.limit

Examples

  block( temp.potsdam )

theGreatWhiteShark/climex documentation built on July 13, 2022, 9:11 a.m.