check.completeness: Checking for N complete years of data

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

Checking for N complete years of data

Description

This function tests whether the series do has at least number.of.years complete years of data.

Usage

check.completeness(x, number.of.years = 30, mc.cores = NULL)

Arguments

x	Either a time series of class xts or a list of them.
number.of.years	The minimum number of complete years in the series. Default = 30.
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

It uses the remove.incomplete.years to check for the completeness of the individual years.

Value

If the input is of type xts, the function returns TRUE or FALSE. If the input, on the other hand, is a list of objects of type xts, it returns a trimmed list containing only those elements, which indeed have more than N years of complete data.

Author(s)

Philipp Mueller

See Also

Other ts: aic.climex.fit.gev, aic.climex.fit.gpd, aic.list, aic, anomalies.list, anomalies.xts, anomalies, bic.climex.fit.gev, bic.climex.fit.gpd, bic.list, bic, remove.incomplete.years.list, remove.incomplete.years.xts, remove.incomplete.years, remove.seasonality.list, remove.seasonality.xts, remove.seasonality

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