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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/checkCount.R
\name{checkCount}
\alias{checkCount}
\alias{check_count}
\alias{assertCount}
\alias{assert_count}
\alias{testCount}
\alias{test_count}
\alias{expect_count}
\title{Check if an argument is a count}
\usage{
checkCount(
x,
na.ok = FALSE,
positive = FALSE,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE
)
check_count(
x,
na.ok = FALSE,
positive = FALSE,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE
)
assertCount(
x,
na.ok = FALSE,
positive = FALSE,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE,
coerce = FALSE,
.var.name = vname(x),
add = NULL
)
assert_count(
x,
na.ok = FALSE,
positive = FALSE,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE,
coerce = FALSE,
.var.name = vname(x),
add = NULL
)
testCount(
x,
na.ok = FALSE,
positive = FALSE,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE
)
test_count(
x,
na.ok = FALSE,
positive = FALSE,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE
)
expect_count(
x,
na.ok = FALSE,
positive = FALSE,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE,
info = NULL,
label = vname(x)
)
}
\arguments{
\item{x}{[any]\cr
Object to check.}
\item{na.ok}{[\code{logical(1)}]\cr
Are missing values allowed? Default is \code{FALSE}.}
\item{positive}{[\code{logical(1)}]\cr
Must \code{x} be positive (>= 1)?
Default is \code{FALSE}, allowing 0.}
\item{tol}{[\code{double(1)}]\cr
Numerical tolerance used to check whether a double or complex can be converted.
Default is \code{sqrt(.Machine$double.eps)}.}
\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{coerce}{[\code{logical(1)}]\cr
If \code{TRUE}, the input \code{x} is returned as integer after an successful assertion.}
\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{assertCount}/\code{assert_count} return
\code{x} invisibly, whereas
\code{checkCount}/\code{check_count} and
\code{testCount}/\code{test_count} return
\code{TRUE}.
If the check is not successful,
\code{assertCount}/\code{assert_count}
throws an error message,
\code{testCount}/\code{test_count}
returns \code{FALSE},
and \code{checkCount}/\code{check_count}
return a string with the error message.
The function \code{expect_count} always returns an
\code{\link[testthat]{expectation}}.
}
\description{
A count is defined as non-negative integerish value.
}
\details{
This function does not distinguish between
\code{NA}, \code{NA_integer_}, \code{NA_real_}, \code{NA_complex_}
\code{NA_character_} and \code{NaN}.
}
\note{
To perform an assertion and then convert to integer, use \code{\link{asCount}}.
\code{assertCount} will not convert numerics to integer.
}
\examples{
testCount(1)
testCount(-1)
}
\seealso{
Other scalars:
\code{\link{checkFlag}()},
\code{\link{checkInt}()},
\code{\link{checkNumber}()},
\code{\link{checkScalar}()},
\code{\link{checkScalarNA}()},
\code{\link{checkString}()}
}
\concept{scalars}
|
