isRegular {timeSeries}R Documentation

Checks if a time series is regular

Description

Checks if a time series is regular. i.e. if a series is a daily, a monthly, or a weekly time series. If the series is regular the frequency of the serie scan determined calling the function frequency.

Usage

## S4 method for signature 'timeSeries'
isDaily(x)
## S4 method for signature 'timeSeries'
isMonthly(x)
## S4 method for signature 'timeSeries'
isQuarterly(x)

## S4 method for signature 'timeSeries'
isRegular(x)

## S4 method for signature 'timeSeries'
frequency(x, ...)

Arguments

x

an R object of class timeSeries.

...

arguments to be passed.

Details

A time series is defined as daily if the series has not more than one date/time stamp per day.

A time series is defined as monthly if the series has not more than one date/time stamp per month.

A time series is defined as quarterly if the series has not more than one date/time stamp per quarter.

A monthly series is also a daily series, a quarterly series is also a monthly series.

A regular series is either a monthly or a quarterly series.

NOT yet implemented is the case of weekly series.

Value

The is* functions return TRUE or FALSE depending on whether the series fulfills the condition or not.

The function frequency returns in general 1, for quarterly series 4, and for monthly series 12.

Examples

## None

[Package timeSeries version 2160.95 Index]