Description Usage Arguments Details Value Note See Also Examples
Meant for use in a data analysis pipeline, this function will just return the data it's supplied if there are no FALSEs when the predicate is applied to every element of the columns indicated. If any element in any of the columns, when applied to the predicate, is FALSE, then this function will raise an error, effectively terminating the pipeline early.
1 2 3 4 5 | assert(data, predicate, ..., success_fun = success_continue,
error_fun = error_stop)
assert_(data, predicate, ..., .dots, success_fun = success_continue,
error_fun = error_stop)
|
data |
A data frame |
predicate |
A function that returns FALSE when violated |
... |
Comma separated list of unquoted expressions.
Uses dplyr's |
success_fun |
Function to call if assertion passes. Defaults to
returning |
error_fun |
Function to call if assertion fails. Defaults to printing a summary of all errors. |
.dots |
Use assert_() to select columns using standard evaluation. |
For examples of possible choices for the success_fun
and
error_fun
parameters, run help("success_and_error_functions")
By default, the data
is returned if predicate assertion
is TRUE and and error is thrown if not. If a non-default
success_fun
or error_fun
is used, the return
values of these function will be returned.
See vignette("assertr")
for how to use this in context
verify
insist
assert_rows
insist_rows
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 | # returns mtcars
assert(mtcars, not_na, vs)
# equivalent statements using standard evaluation
assert_(mtcars, not_na, "vs")
var <- "vs"
assert_(mtcars, not_na, var)
# return mtcars
assert(mtcars, not_na, mpg:carb)
# equivalent using standard evaluation
assert_(mtcars, not_na, "mpg:carb")
library(magrittr) # for piping operator
mtcars %>%
assert(in_set(c(0,1)), vs)
# anything here will run
## Not run:
mtcars %>%
assert(in_set(c(1, 2, 3, 4, 6)), carb)
# the assertion is untrue so
# nothing here will run
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.