error_on_false: check helper

View source: R/base_check.R

error_on_falseR Documentation

check helper

Description

check helper

Usage

error_on_false(
  check,
  x,
  var_name,
  input_name,
  allow_null,
  allow_na,
  expected,
  call,
  class
)

Arguments

check

boolean statement to check

x

the variable to check

var_name

the variable name the user gave the input

input_name

the name of the input we are checking

allow_null

allow check to pass if x is null

allow_na

allow check to pass if any element of x is na

expected

a string describing what the input should be

call

the call environment

class

the class of the error

Value

invisible true/falses


kristianSN/checkR documentation built on Dec. 12, 2023, 10:45 a.m.