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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/api.R
\name{is_complete}
\alias{is_complete}
\title{Indicates if the time series is complete}
\usage{
is_complete(x)
}
\arguments{
\item{x}{An instance of the \link{CFTime} class.}
}
\value{
logical. \code{TRUE} if the time series is complete, with no gaps;
\code{FALSE} otherwise. If no offsets have been added to the \code{CFTime} instance,
\code{NA} is returned.
}
\description{
This function indicates if the time series is complete, meaning that the time
steps are equally spaced and there are thus no gaps in the time series.
}
\details{
This function gives exact results for time series where the nominal
\emph{unit of separation} between observations in the time series is exact in
terms of the calendar unit. As an example, for a calendar unit of "days" where the
observations are spaced a fixed number of days apart the result is exact, but
if the same calendar unit is used for data that is on a monthly basis, the
\emph{assessment} is approximate because the number of days per month is variable
and dependent on the calendar (the exception being the \verb{360_day} calendar,
where the assessment is exact). The \emph{result} is still correct in most cases
(including all CF-compliant data sets that the developers have seen) although
there may be esoteric constructions of CFTime and offsets that trip up this
implementation.
}
\examples{
t <- CFtime("days since 1850-01-01", "julian", 0:364)
is_complete(t)
}
|
