insist: Raises error if dynamically created predicate is FALSE in any...

In lorenzwalthert/assertr: Assertive Programming for R Analysis Pipelines

Description

Meant for use in a data analysis pipeline, this function applies a predicate generating function to each of the columns indicated. It will then use these predicates to check every element of those columns. If any of these predicate applications yield FALSE, this function will raise an error, effectively terminating the pipeline early. If there are no FALSES, this function will just return the data that it was supplied for further use in later parts of the pipeline.

Usage

insist(data, predicate_generator, ..., success_fun = success_continue,
  error_fun = error_stop)

insist_(data, predicate_generator, ..., .dots, success_fun = success_continue,
  error_fun = error_stop)

Arguments

data	A data frame
predicate_generator	A function that is applied to each of the column vectors selected. This will produce, for every column, a true predicate function to be applied to every element in the column vectors selected
...	Comma separated list of unquoted expressions. Uses dplyr's select to select columns from data.
success_fun	Function to call if assertion passes. Defaults to returning data.
error_fun	Function to call if assertion fails. Defaults to printing a summary of all errors.
.dots	Use insist_() to select columns using standard evaluation.

Details

For examples of possible choices for the success_fun and error_fun parameters, run help("success_and_error_functions")

Value

By default, the data is returned if dynamically created 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.

Note

See vignette("assertr") for how to use this in context

See Also

assert verify insist_rows assert_rows

Examples

insist(iris, within_n_sds(3), Sepal.Length)   # returns iris

# equivalent using standard evaluation
insist_(iris, within_n_sds(3), "Sepal.Length")

library(magrittr)

iris %>%
  insist(within_n_sds(4), Sepal.Length:Petal.Width)
  # anything here will run

## Not run: 
iris %>%
  insist(within_n_sds(3), Sepal.Length:Petal.Width)
  # datum at index 16 of 'Sepal.Width' vector is (4.4)
  # is outside 3 standard deviations from the mean of Sepal.Width.
  # The check fails, raises a fatal error, and the pipeline
  # is terminated so nothing after this statement will run
## End(Not run)

lorenzwalthert/assertr documentation built on May 20, 2019, 4:06 p.m.