## File: calendar-isRegular.Rd

package info (click to toggle)
r-cran-timedate 3012.100-2
 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091 \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}