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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/checkPOSIXct.R
\name{checkPOSIXct}
\alias{checkPOSIXct}
\alias{check_posixct}
\alias{assertPOSIXct}
\alias{assert_posixct}
\alias{testPOSIXct}
\alias{test_posixct}
\alias{expect_posixct}
\title{Check that an argument is a date/time object in POSIXct format}
\usage{
checkPOSIXct(
x,
lower = NULL,
upper = NULL,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
null.ok = FALSE
)
check_posixct(
x,
lower = NULL,
upper = NULL,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
null.ok = FALSE
)
assertPOSIXct(
x,
lower = NULL,
upper = NULL,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
null.ok = FALSE,
.var.name = vname(x),
add = NULL
)
assert_posixct(
x,
lower = NULL,
upper = NULL,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
null.ok = FALSE,
.var.name = vname(x),
add = NULL
)
testPOSIXct(
x,
lower = NULL,
upper = NULL,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
null.ok = FALSE
)
test_posixct(
x,
lower = NULL,
upper = NULL,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
null.ok = FALSE
)
expect_posixct(
x,
lower = NULL,
upper = NULL,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
null.ok = FALSE,
info = NULL,
label = vname(x)
)
}
\arguments{
\item{x}{[any]\cr
Object to check.}
\item{lower}{[\code{\link[base]{Date}}]\cr
All non-missing dates in \code{x} must be >= this POSIXct time. Must be provided in the same timezone as \code{x}.}
\item{upper}{[\code{\link[base]{Date}}]\cr
All non-missing dates in \code{x} must be <= this POSIXct time. Must be provided in the same timezone as \code{x}.}
\item{any.missing}{[\code{logical(1)}]\cr
Are vectors with missing values allowed? Default is \code{TRUE}.}
\item{all.missing}{[\code{logical(1)}]\cr
Are vectors with no non-missing values allowed? Default is \code{TRUE}.
Note that empty vectors do not have non-missing values.}
\item{len}{[\code{integer(1)}]\cr
Exact expected length of \code{x}.}
\item{min.len}{[\code{integer(1)}]\cr
Minimal length of \code{x}.}
\item{max.len}{[\code{integer(1)}]\cr
Maximal length of \code{x}.}
\item{unique}{[\code{logical(1)}]\cr
Must all values be unique? Default is \code{FALSE}.}
\item{sorted}{[\code{logical(1)}]\cr
Elements must be sorted in ascending order. Missing values are ignored.}
\item{null.ok}{[\code{logical(1)}]\cr
If set to \code{TRUE}, \code{x} may also be \code{NULL}.
In this case only a type check of \code{x} is performed, all additional checks are disabled.}
\item{.var.name}{[\code{character(1)}]\cr
Name of the checked object to print in assertions. Defaults to
the heuristic implemented in \code{\link{vname}}.}
\item{add}{[\code{AssertCollection}]\cr
Collection to store assertion messages. See \code{\link{AssertCollection}}.}
\item{info}{[\code{character(1)}]\cr
Extra information to be included in the message for the testthat reporter.
See \code{\link[testthat]{expect_that}}.}
\item{label}{[\code{character(1)}]\cr
Name of the checked object to print in messages. Defaults to
the heuristic implemented in \code{\link{vname}}.}
}
\value{
Depending on the function prefix:
If the check is successful, the functions
\code{assertAtomic}/\code{assert_atomic} return
\code{x} invisibly, whereas
\code{checkAtomic}/\code{check_atomic} and
\code{testAtomic}/\code{test_atomic} return
\code{TRUE}.
If the check is not successful,
\code{assertAtomic}/\code{assert_atomic}
throws an error message,
\code{testAtomic}/\code{test_atomic}
returns \code{FALSE},
and \code{checkAtomic}/\code{check_atomic}
return a string with the error message.
The function \code{expect_atomic} always returns an
\code{\link[testthat]{expectation}}.
}
\description{
Checks that an object is of class \code{\link[base]{POSIXct}}.
}
\seealso{
Other basetypes:
\code{\link{checkArray}()},
\code{\link{checkAtomic}()},
\code{\link{checkAtomicVector}()},
\code{\link{checkCharacter}()},
\code{\link{checkComplex}()},
\code{\link{checkDataFrame}()},
\code{\link{checkDate}()},
\code{\link{checkDouble}()},
\code{\link{checkEnvironment}()},
\code{\link{checkFactor}()},
\code{\link{checkFormula}()},
\code{\link{checkFunction}()},
\code{\link{checkInteger}()},
\code{\link{checkIntegerish}()},
\code{\link{checkList}()},
\code{\link{checkLogical}()},
\code{\link{checkMatrix}()},
\code{\link{checkNull}()},
\code{\link{checkNumeric}()},
\code{\link{checkRaw}()},
\code{\link{checkVector}()}
}
\concept{basetypes}
|
