validate_if: Verify if expression regarding data is TRUE

View source: R/assertions.R

validate_ifR Documentation

Verify if expression regarding data is TRUE

Description

The function checks whether all the logical values returned by the expression are TRUE. The function is meant for handling all the cases that cannot be reached by using validate_cols and validate_rows functions.

Usage

validate_if(
  data,
  expr,
  description = NA,
  obligatory = FALSE,
  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

expr

A Logical expression to test for, e.g. var_name > 0

description

A character string with description of assertion. The description is then displayed in the validation report

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

skip_chain_opts

While wrapping data with validate function, success_fun and error_fun parameters are rewritten with success_append and error_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

See Also

validate_cols validate_rows


data.validator documentation built on May 31, 2023, 7:05 p.m.