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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/assert-identical-to-true-false-na.R,
% R/assert-is-true-false-na.R, R/is-identical-to-true-false-na.R,
% R/is-true-false-na.R
\name{Truth}
\alias{Truth}
\alias{assert_is_identical_to_false}
\alias{assert_is_identical_to_na}
\alias{assert_is_identical_to_true}
\alias{assert_all_are_false}
\alias{assert_any_are_false}
\alias{assert_all_are_na}
\alias{assert_any_are_na}
\alias{assert_all_are_true}
\alias{assert_any_are_true}
\alias{assert_all_are_not_false}
\alias{assert_any_are_not_false}
\alias{assert_all_are_not_na}
\alias{assert_any_are_not_na}
\alias{assert_all_are_not_true}
\alias{assert_any_are_not_true}
\alias{is_identical_to_false}
\alias{is_identical_to_na}
\alias{is_identical_to_true}
\alias{is_false}
\alias{is_na}
\alias{is_not_na}
\alias{is_not_false}
\alias{is_not_true}
\alias{is_true}
\title{Is the input TRUE/FALSE/NA?}
\usage{
assert_is_identical_to_false(
x,
allow_attributes = FALSE,
severity = getOption("assertive.severity", "stop")
)
assert_is_identical_to_na(
x,
allow_attributes = FALSE,
severity = getOption("assertive.severity", "stop")
)
assert_is_identical_to_true(
x,
allow_attributes = FALSE,
severity = getOption("assertive.severity", "stop")
)
assert_all_are_false(x, severity = getOption("assertive.severity", "stop"))
assert_any_are_false(x, severity = getOption("assertive.severity", "stop"))
assert_all_are_na(x, severity = getOption("assertive.severity", "stop"))
assert_any_are_na(x, severity = getOption("assertive.severity", "stop"))
assert_all_are_true(x, severity = getOption("assertive.severity", "stop"))
assert_any_are_true(x, severity = getOption("assertive.severity", "stop"))
assert_all_are_not_false(x, severity = getOption("assertive.severity", "stop"))
assert_any_are_not_false(x, severity = getOption("assertive.severity", "stop"))
assert_all_are_not_na(x, severity = getOption("assertive.severity", "stop"))
assert_any_are_not_na(x, severity = getOption("assertive.severity", "stop"))
assert_all_are_not_true(x, severity = getOption("assertive.severity", "stop"))
assert_any_are_not_true(x, severity = getOption("assertive.severity", "stop"))
is_identical_to_false(
x,
allow_attributes = FALSE,
.xname = get_name_in_parent(x)
)
is_identical_to_na(x, allow_attributes = FALSE, .xname = get_name_in_parent(x))
is_identical_to_true(
x,
allow_attributes = FALSE,
.xname = get_name_in_parent(x)
)
is_false(x, .xname = get_name_in_parent(x))
is_na(x, coerce_to_logical = FALSE, .xname = get_name_in_parent(x))
is_not_na(x, coerce_to_logical = FALSE, .xname = get_name_in_parent(x))
is_not_false(x, .xname = get_name_in_parent(x))
is_not_true(x, .xname = get_name_in_parent(x))
is_true(x, .xname = get_name_in_parent(x))
}
\arguments{
\item{x}{Input to check. See note.}
\item{allow_attributes}{If \code{TRUE}, a scalar value of \code{TRUE}
with attributes is allowed.}
\item{severity}{How severe should the consequences of the assertion be?
Either \code{"stop"}, \code{"warning"}, \code{"message"}, or \code{"none"}.}
\item{.xname}{Not intended to be used directly.}
\item{coerce_to_logical}{Logical: should the input be coerced to logical
before checking? See note.}
}
\value{
The \code{is*} functions return \code{TRUE} if the input is
\code{TRUE}/\code{FALSE}. The \code{assert_*} functions return nothing but
throw an error if the corresponding \code{is_*} function returns
\code{FALSE}.
}
\description{
Checks to see if the input is \code{TRUE}, \code{FALSE} or \code{NA}.
}
\note{
\code{is_identical_to_true} wraps the base function \code{isTRUE},
providing more information on failure. Likewise,
\code{is_identical_to_false} checks that the input is identical to FALSE. If
\code{allow_attributes} is \code{TRUE}, a scalar value of \code{TRUE} with
attributes is allowed. \code{is_true} and \code{is_false} are vectorized,
returning \code{TRUE} when the inputs are \code{TRUE} and \code{FALSE}
respectively.
The for \code{is_true}, \code{is_false}, \code{is_not_true} and
\code{is_not_false}, \code{x} argument will be coerced to be a logical vector
if it isn't already.
Coercion to logical is optional for \code{is_na} and \code{is_not_na}. If
you do coerce, it means that \code{is_na} differs in behaviour from
\code{base::is.na} for character vector, list and data frame inputs. To
replicate the behaviour of \code{is.na}, ensure the argument
\code{coerce_to_logical} is \code{FALSE} (this is the default).
Note that in assertive version 0.1-4 and prior,
\code{is_identical_to_true/false} were named \code{is_true/false} and the
vectorized versions were not present.
}
\examples{
# Checks against logical values using base::identical
assert_is_identical_to_true(TRUE)
assert_is_identical_to_false(FALSE)
assert_is_identical_to_na(NA)
# Other NA types match
assert_is_identical_to_na(NA_complex_)
# NaN is not NA
dont_stop(assert_is_identical_to_na(NaN))
# For a slightly less strict test, you can ignore attributes
assert_is_identical_to_true(c(truth = TRUE), allow_attributes = TRUE)
assert_is_identical_to_false(matrix(FALSE), allow_attributes = TRUE)
assert_is_identical_to_na(structure(NA, class = "nanana"), allow_attributes = TRUE)
# Vectorized predicates (package name explicitly given to prevent
# problems with testthat name clash)
x <- c(TRUE, FALSE, NA)
assertive.base::is_true(x)
assertive.base::is_false(x)
is_na(x)
# ...and their opposites
is_not_true(x)
is_not_false(x)
is_not_na(x)
# Check that at least one element fits the condition
assert_any_are_true(x)
assert_any_are_false(x)
assert_any_are_na(x)
# These checks should fail:
dont_stop({
assert_is_identical_to_true(c(truth = TRUE))
assert_is_identical_to_true(1)
assert_is_identical_to_true(c(TRUE, TRUE))
assert_is_identical_to_false(matrix(FALSE))
assert_is_identical_to_na(structure(NA, class = "nanana"))
assert_all_are_true(x)
assert_all_are_false(x)
assert_all_are_na(x)
})
# base::is.na has non-standard behaviour for data.frames and lists.
# is_na and is_not_na coerce to logical vectors (except character input).
# unlist the input or use an apply function.
d <- data.frame(
x = c(TRUE, FALSE, NA),
y = c(0, NA, 2),
z = c("a", "NA", NA)
)
is.na(d)
is_na(unlist(d))
}
\seealso{
\code{\link[base]{isTRUE}}.
}
|
