Skip to contents

Package index

Missing Input Checkers

Check if the function input is missing or not

chk_missing() vld_missing()
Check Missing Argument
chk_not_missing() vld_not_missing()
Check Not Missing Argument

… Checkers

Check if the function input comes from … (dot-dot-dot) or not

chk_used() vld_used()
Check ... Used
chk_unused() vld_unused()
Check ... Unused

External Data Source Checkers

Check if the function input is a valid external data source

chk_file() vld_file()
Check File Exists
chk_ext() vld_ext()
Check File Extension
chk_dir() vld_dir()
Check Directory Exists

NULL Checkers

Check if the function input is NULL or not or something else

chk_null() vld_null()
Check NULL
chk_not_null() vld_not_null()
Check not NULL
chk_null_or()
Check NULL Or

Data Structure Checkers

Check if the function input has a specific data structure

chk_vector() vld_vector()
Check Vector
chk_atomic() vld_atomic()
Check Atomic
chk_array() vld_array()
Check Array
chk_matrix() vld_matrix()
Check Matrix
chk_list() vld_list()
Check List
chk_data() vld_data()
Check Data

Data Type Checkers

Check if the function input has a data type

chk_environment() vld_environment()
Check Environment
chk_logical() vld_logical()
Check Logical
chk_complex() vld_complex()
Check Complex
chk_character() vld_character()
Check Character
chk_numeric() vld_numeric()
Check Numeric
chk_double() vld_double()
Check Double
chk_integer() vld_integer()
Check Integer
chk_raw() vld_raw()
Check Raw

Whole Number Checkers

Check if the function input is a whole number, whether explicitly an integer or a double type without fractional parts

chk_whole_numeric() vld_whole_numeric()
Check Whole Numeric
chk_whole_number() vld_whole_number()
Check Whole Number
chk_count() vld_count()
Check Count

Factor Checker

Check if the function input is a factor

chk_factor() vld_factor()
Check Factor
chk_character_or_factor() vld_character_or_factor()
Check Character or Factor

Scalar Checkers

Check if the function input is a vector of length 1

chk_scalar() vld_scalar()
Check Scalar
chk_string() vld_string()
Check String
chk_number() vld_number()
Check Number
chk_complex_number() vld_complex_number()
Check Complex Number
chk_flag() vld_flag()
Check Flag
chk_true() vld_true()
Check TRUE
chk_false() vld_false()
Check FALSE

Date or DateTime Checkers

Check if the function input is of class Date or DateTime

chk_date() vld_date()
Check Date
chk_date_time() chk_datetime() vld_date_time() vld_datetime()
Check Date Time

Time Zone Checker

Check if the function input is a Time Zone

chk_tz() vld_tz()
Check Time Zone

All Elements Checker

Check if the function input has a characteristic shared by all its elements

chk_all() vld_all()
Check All

Function Checker

Check if the function input is another function

chk_function() vld_function()
Check Function

Names Checkers

Check if the function input has names and are valid

chk_named() vld_named()
Check Named
chk_valid_name() vld_valid_name()
Check Valid Name

Range Checkers

Check if the function input is part of a range of values

chk_range() vld_range()
Checks range of non-missing values
chk_lt() vld_lt()
Check Less Than
chk_lte() vld_lte()
Check Less Than or Equal To
chk_gt() vld_gt()
Check Greater Than
chk_gte() vld_gte()
Check Greater Than or Equal To

Equal Checkers

Check if the function input is equal or similar to a predefined object

chk_identical() vld_identical()
Check Identical
chk_equal() vld_equal()
Check Equal
chk_equivalent() vld_equivalent()
Check Equivalent
chk_all_identical() vld_all_identical()
Check All Identical
chk_all_equal() vld_all_equal()
Check All Equal
chk_all_equivalent() vld_all_equivalent()
Check All Equivalent

Order Checker

Check if the function input are numbers in increasing order

chk_sorted() vld_sorted()
Check Sorted

Set Checkers

Check if the function input is composed by certain elements

vld_not_subset() chk_subset() vld_subset()
Check Subset
chk_not_subset()
Check Not Subset
chk_superset() vld_superset()
Check Superset
vld_orderset() chk_setequal() vld_setequal()
Check Set Equal
chk_orderset()
Check Set Ordered

Identity Checkers

Check if the function input belongs to a class

chk_is() vld_is()
Check Class
chk_s3_class() vld_s3_class()
Check Type
chk_s4_class() vld_s4_class()
Check Inherits from S4 Class

REGEX Checker

Check if the function input matches a REGEX

chk_match() vld_match()
Check Matches

Length Checkers

Check if the function input object’s length is a specific value or if because of its length can be strictly recycled

chk_length() vld_length()
Check Length
chk_compatible_lengths() vld_compatible_lengths()
Check Compatible Lengths

Quality Checkers (Miscellaneous)

Check if the function input meet some user defined quality criteria

chk_not_any_na() vld_not_any_na()
Check Not Any Missing Values
chk_not_empty() vld_not_empty()
Check Not Empty
chk_sorted() vld_sorted()
Check Sorted
chk_unique() vld_unique()
Check Unique
chk_join() vld_join()
Check Join
chkor_vld()
Chk OR

chk_ Function Extenders

Extending chk_ functions

deparse_backtick_chk() backtick_chk() unbacktick_chk()
Deparse Backtick
message_chk()
Construct Tidyverse Style Message
abort_chk()
Abort Check
expect_chk_error()
Expect Chk Error

Message Generators

Generating messages

err() wrn() msg()
Stop, Warning and Message Messages

String Manipulators

Manipulating strings

p() p0()
Concatenate Strings
cc()
Concatenate with Commas

check_ Functions

Checks more properties about the objects

check_data()
Check Data
check_dim()
Check Dimension
check_dirs()
Check Directories Exist
check_files()
Check Files Exist
check_key()
Check Key
check_length()
Check Length
check_names()
Check Names
check_values()
Check Values and Class

Deprecated Functions

Functions that have been deprecated

chk_chr() vld_chr() deprecated
Check Character Scalar
chk_dbl() vld_dbl() deprecated
Check Double Scalar
chk_lgl() vld_lgl()
Check Logical Scalar
chk_wnum() vld_wnum() deprecated
Check Whole Numeric Scalar
chkor()
Check OR