Validation on columns
Usage
validate_cols(
data,
predicate,
...,
obligatory = FALSE,
description = NA,
skip_chain_opts = FALSE,
success_fun = assertr::success_append,
error_fun = assertr::error_append,
defect_fun = assertr::defect_append
)
Arguments
- data
A data.frame or tibble to test
- predicate
Predicate function or predicate generator such as
in_set
orwithin_n_sds
- ...
Columns selection that
predicate
should be called on. All tidyselectlanguage
methods are supported. If not provided, alleverything
will be used.- obligatory
If TRUE and assertion failed the data is marked as defective. For defective data, all the following rules are handled by defect_fun function
- description
A character string with description of assertion. The description is then displayed in the validation report
- skip_chain_opts
While wrapping data with validate function,
success_fun
anderror_fun
parameters are rewritten withsuccess_append
anderror_append
respectively. In order to use parameters assigned to the function directly set skip_chain_opts to TRUE- success_fun
Function that is called when the validation pass
- error_fun
Function that is called when the validation fails
- defect_fun
Function that is called when the data is marked as defective