1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
|
\name{isRegular}
\title{Checks if a date/time vector is regular}
\alias{isDaily}
\alias{isMonthly}
\alias{isQuarterly}
\alias{isRegular}
\alias{frequency}
\alias{isDaily,timeDate-method}
\alias{isMonthly,timeDate-method}
\alias{isQuarterly,timeDate-method}
\alias{isRegular,timeDate-method}
\alias{frequency,timeDate-method}
\description{
Checks if a date/time vector is regular. i.e. if it is
a daily, a monthly, or a quarterly date/time vector. If
the date/time vector is regular the frequency can determined
calling the function frequency.
}
\usage{
\S4method{isDaily}{timeDate}(x)
\S4method{isMonthly}{timeDate}(x)
\S4method{isQuarterly}{timeDate}(x)
\S4method{isRegular}{timeDate}(x)
\S4method{frequency}{timeDate}(x, \dots)
}
\arguments{
\item{x}{
an R object of class \code{timeDate}.
}
\item{\dots}{
arguments to be passed
}
}
\details{
A date/time vector is defined as daily if the vector has not more
than one date/time stamp per day.
A date/time vector is defined as monthly if the vector has not more
than one date/time stamp per month.
A date/time vector is defined as quarterly if the vector has not more
than one date/time stamp per quarter.
A monthly date/time vector is also a daily vector, a quarterly date/time
vector is also a monthly vector.
A regular date/time vector is either a monthly or a quarterly vector.
NOT yet implemented is the case of weekly vectors.
}
\value{
The \code{is*} functions return \code{TRUE} or \code{FALSE} depending
on whether the date/time vector fulfills the condition or not.
The function frequency returns in general 1, for quarterly date/time
vectors 4, and for monthly vectors 12.
}
\examples{
## None
}
\keyword{chron}
|