,
Kirill Müller [aut] ,
Ayla Pearson [aut] ,
Nadine Hussein [ctb] ,
Evan Amies-Galonski [ctb] ,
Poisson Consulting [cph, fnd]| Title: | Check User-Supplied Function Arguments |
|---|---|
| Description: | For developers to check user-supplied function arguments. It is designed to be simple, fast and customizable. Error messages follow the tidyverse style guide. |
| Authors: | Joe Thorley [aut, cre] ,
Kirill Müller [aut] ,
Ayla Pearson [aut] ,
Nadine Hussein [ctb] ,
Evan Amies-Galonski [ctb] ,
Poisson Consulting [cph, fnd] |
| Maintainer: | Joe Thorley <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.9.2 |
| Built: | 2024-07-05 04:28:06 UTC |
| Source: | https://github.com/poissonconsulting/chk |
A wrapper on err() that sets the subclass to be 'chk_error'.
abort_chk(..., n = NULL, tidy = TRUE, call = rlang::caller_call(2))abort_chk(..., n = NULL, tidy = TRUE, call = rlang::caller_call(2))
... |
Multiple objects that are converted to a string using
|
n |
The value of n for converting |
tidy |
A flag specifying whether capitalize the first character and add a missing period. |
call |
The execution environment of a currently running
function, e.g. You only need to supply Can also be For more information about error calls, see Including function calls in error messages. |
It is exported to allow users to easily construct their own chk_ functions.
Throws an error of class 'chk_error'.
try(abort_chk("x must be NULL")) try(abort_chk("`x` must be NULL")) try(abort_chk("there %r %n problem value%s", n = 1)) try(abort_chk("there %r %n problem value%s", n = 1.5))try(abort_chk("x must be NULL")) try(abort_chk("`x` must be NULL")) try(abort_chk("there %r %n problem value%s", n = 1)) try(abort_chk("there %r %n problem value%s", n = 1.5))
Concatenates object values into a string with each value separated by a comma and the last value separated by a conjunction.
cc( x, conj = ", ", sep = ", ", brac = if (is.character(x) || is.factor(x)) "'" else "", ellipsis = 10L, chk = TRUE )cc( x, conj = ", ", sep = ", ", brac = if (is.character(x) || is.factor(x)) "'" else "", ellipsis = 10L, chk = TRUE )
x |
The object to concatenate. |
conj |
A string of the conjunction to separate the last value by. |
sep |
A string of the separator. |
brac |
A string to brac the values by. |
ellipsis |
A numeric scalar of the maximum number of values to display before using an ellipsis. |
chk |
A flag specifying whether to check the other parameters. |
By default, if x has more than 10 values an ellipsis is used to ensure only 10 values are displayed (including the ellipsis).
A string.
cc(1:2) cc(1:2, conj = " or") cc(3:1, brac = "'") cc(1:11) cc(as.character(1:2))cc(1:2) cc(1:2, conj = " or") cc(3:1, brac = "'") cc(1:11) cc(as.character(1:2))
Checks column names, values, number of rows and key for a data.frame.
check_data( x, values = NULL, exclusive = FALSE, order = FALSE, nrow = numeric(0), key = character(0), x_name = NULL )check_data( x, values = NULL, exclusive = FALSE, order = FALSE, nrow = numeric(0), key = character(0), x_name = NULL )
x |
The object to check. |
values |
A uniquely named list of atomic vectors of the column values. |
exclusive |
A flag specifying whether x must only include columns named in values. |
order |
A flag specifying whether the order of columns in x must match names in values. |
nrow |
A flag or a whole numeric vector of the value, value range or possible values. |
key |
A character vector of the columns that represent a unique key. |
x_name |
A string of the name of object x or NULL. |
An informative error if the test fails or an invisible copy of x.
Other check:
check_dim(),
check_dirs(),
check_files(),
check_key(),
check_names(),
check_values()
check_data(data.frame()) check_data(data.frame(x = 2), list(x = 1)) try(check_data(data.frame(x = 2), list(y = 1L))) try(check_data(data.frame(x = 2), list(y = 1))) try(check_data(data.frame(x = 2), nrow = 2))check_data(data.frame()) check_data(data.frame(x = 2), list(x = 1)) try(check_data(data.frame(x = 2), list(y = 1L))) try(check_data(data.frame(x = 2), list(y = 1))) try(check_data(data.frame(x = 2), nrow = 2))
Checks dimension of an object.
check_dim(x, dim = length, values = numeric(0), x_name = NULL, dim_name = NULL)check_dim(x, dim = length, values = numeric(0), x_name = NULL, dim_name = NULL)
x |
The object to check. |
dim |
A function returning a non-negative whole number of the dimension. |
values |
A flag or a whole numeric vector of the value, value range or possible values. |
x_name |
A string of the name of object x or NULL. |
dim_name |
A string of the name of the dim function. |
An informative error if the test fails or an invisible copy of x.
Other check:
check_data(),
check_dirs(),
check_files(),
check_key(),
check_names(),
check_values()
check_dim(1) try(check_dim(1, values = FALSE)) try(check_dim(1, values = c(10, 2))) try(check_dim(data.frame(x = 1), dim = nrow, values = c(10, 10, 2)))check_dim(1) try(check_dim(1, values = FALSE)) try(check_dim(1, values = c(10, 2))) try(check_dim(data.frame(x = 1), dim = nrow, values = c(10, 10, 2)))
Checks if all directories exist (or if exists = FALSE do not exist as directories or files).
check_dirs(x, exists = TRUE, x_name = NULL)check_dirs(x, exists = TRUE, x_name = NULL)
x |
The object to check. |
exists |
A flag specifying whether the files/directories must (or must not) exist. |
x_name |
A string of the name of object x or NULL. |
An informative error if the test fails or an invisible copy of x.
Other check:
check_data(),
check_dim(),
check_files(),
check_key(),
check_names(),
check_values()
check_dirs(tempdir()) try(check_dirs(tempdir(), exists = FALSE))check_dirs(tempdir()) try(check_dirs(tempdir(), exists = FALSE))
Checks if all files exist (or if exists = FALSE do not exist as files or directories).
check_files(x, exists = TRUE, x_name = NULL)check_files(x, exists = TRUE, x_name = NULL)
x |
The object to check. |
exists |
A flag specifying whether the files/directories must (or must not) exist. |
x_name |
A string of the name of object x or NULL. |
An informative error if the test fails or an invisible copy of x.
Other check:
check_data(),
check_dim(),
check_dirs(),
check_key(),
check_names(),
check_values()
check_files(tempfile("unlikely-that-exists-chk"), exists = FALSE) try(check_files(tempfile("unlikely-that-exists-chk")))check_files(tempfile("unlikely-that-exists-chk"), exists = FALSE) try(check_files(tempfile("unlikely-that-exists-chk")))
Checks if columns have unique rows.
check_key(x, key = character(0), na_distinct = FALSE, x_name = NULL)check_key(x, key = character(0), na_distinct = FALSE, x_name = NULL)
x |
The object to check. |
key |
A character vector of the columns that represent a unique key. |
na_distinct |
A flag specifying whether missing values should be considered distinct. |
x_name |
A string of the name of object x or NULL. |
An informative error if the test fails or an invisible copy of x.
Other check:
check_data(),
check_dim(),
check_dirs(),
check_files(),
check_names(),
check_values()
x <- data.frame(x = c(1, 2), y = c(1, 1)) check_key(x) try(check_key(x, "y"))x <- data.frame(x = c(1, 2), y = c(1, 1)) check_key(x) try(check_key(x, "y"))
Checks the names of an object.
check_names( x, names = character(0), exclusive = FALSE, order = FALSE, x_name = NULL )check_names( x, names = character(0), exclusive = FALSE, order = FALSE, x_name = NULL )
x |
The object to check. |
names |
A character vector of the required names. |
exclusive |
A flag specifying whether x must only contain the required names. |
order |
A flag specifying whether the order of the required names in x must match the order in names. |
x_name |
A string of the name of object x or NULL. |
An informative error if the test fails or an invisible copy of x.
Other check:
check_data(),
check_dim(),
check_dirs(),
check_files(),
check_key(),
check_values()
x <- c(x = 1, y = 2) check_names(x, c("y", "x")) try(check_names(x, c("y", "x"), order = TRUE)) try(check_names(x, "x", exclusive = TRUE))x <- c(x = 1, y = 2) check_names(x, c("y", "x")) try(check_names(x, c("y", "x"), order = TRUE)) try(check_names(x, "x", exclusive = TRUE))
Checks values and S3 class of an atomic object.
check_values(x, values, x_name = NULL)check_values(x, values, x_name = NULL)
x |
The object to check. |
values |
An atomic vector specifying the S3 class and possible values. |
x_name |
A string of the name of object x or NULL. |
To check the class simply pass a vector of the desired class.
To check that x does not include missing values pass a single non-missing value (of the correct class).
To allow it to include missing values include a missing value.
To check that it only includes missing values only pass a missing value (of the correct class).
To check the range of the values in x pass two non-missing values (as well as the missing value if required).
To check that x only includes specific values pass three or more non-missing values.
In the case of a factor ensure values has two levels to check that the levels of x are an ordered superset of the levels of value and three or more levels to check that they are identical.
An informative error if the test fails or an invisible copy of x.
Other check:
check_data(),
check_dim(),
check_dirs(),
check_files(),
check_key(),
check_names()
check_values(1, numeric(0)) check_values(1, 2) try(check_values(1, 1L)) try(check_values(NA_real_, 1))check_values(1, numeric(0)) check_values(1, 2) try(check_values(1, 1L)) try(check_values(NA_real_, 1))
Checks all elements using
all(vapply(x, chk_fun, TRUE, ...))
chk_all(x, chk_fun, ..., x_name = NULL) vld_all(x, vld_fun, ...)chk_all(x, chk_fun, ..., x_name = NULL) vld_all(x, vld_fun, ...)
x |
The object to check. |
chk_fun |
A chk_ function. |
... |
Additional arguments. |
x_name |
A string of the name of object x or NULL. |
vld_fun |
A vld_ function. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_all(): Validate All
Other chk_alls:
chk_all_equal(),
chk_all_equivalent(),
chk_all_identical()
# chk_all chk_all(TRUE, chk_lgl) # FIXME try(chk_all(1, chk_lgl)) chk_all(c(TRUE, NA), chk_lgl) # vld_all vld_all(c(TRUE, NA), vld_lgl)# chk_all chk_all(TRUE, chk_lgl) # FIXME try(chk_all(1, chk_lgl)) chk_all(c(TRUE, NA), chk_lgl) # vld_all vld_all(c(TRUE, NA), vld_lgl)
Checks all elements in x equal using
length(x) < 2L || all(vapply(x, vld_equal, TRUE, y = x[[1]], tolerance = tolerance))
chk_all_equal(x, tolerance = sqrt(.Machine$double.eps), x_name = NULL) vld_all_equal(x, tolerance = sqrt(.Machine$double.eps))chk_all_equal(x, tolerance = sqrt(.Machine$double.eps), x_name = NULL) vld_all_equal(x, tolerance = sqrt(.Machine$double.eps))
x |
The object to check. |
tolerance |
A non-negative numeric scalar. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_all_equal(): Validate All Equal
Other chk_alls:
chk_all(),
chk_all_equivalent(),
chk_all_identical()
# chk_all_equal chk_all_equal(c(1, 1.00000001)) try(chk_all_equal(c(1, 1.0000001))) chk_all_equal(list(c(x = 1), c(x = 1))) try(chk_all_equal(list(c(x = 1), c(y = 1)))) # vld_all_equal vld_all_equal(c(1, 1L))# chk_all_equal chk_all_equal(c(1, 1.00000001)) try(chk_all_equal(c(1, 1.0000001))) chk_all_equal(list(c(x = 1), c(x = 1))) try(chk_all_equal(list(c(x = 1), c(y = 1)))) # vld_all_equal vld_all_equal(c(1, 1L))
Checks all elements in x equivalent using
length(x) < 2L || all(vapply(x, vld_equivalent, TRUE, y = x[[1]], tolerance = tolerance))
chk_all_equivalent(x, tolerance = sqrt(.Machine$double.eps), x_name = NULL) vld_all_equivalent(x, tolerance = sqrt(.Machine$double.eps))chk_all_equivalent(x, tolerance = sqrt(.Machine$double.eps), x_name = NULL) vld_all_equivalent(x, tolerance = sqrt(.Machine$double.eps))
x |
The object to check. |
tolerance |
A non-negative numeric scalar. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_all_equivalent(): Validate All Equivalent
Other chk_alls:
chk_all(),
chk_all_equal(),
chk_all_identical()
# chk_all_equivalent chk_all_equivalent(c(1, 1.00000001)) try(chk_all_equivalent(c(1, 1.0000001))) chk_all_equivalent(list(c(x = 1), c(x = 1))) chk_all_equivalent(list(c(x = 1), c(y = 1))) # vld_all_equivalent vld_all_equivalent(c(x = 1, y = 1))# chk_all_equivalent chk_all_equivalent(c(1, 1.00000001)) try(chk_all_equivalent(c(1, 1.0000001))) chk_all_equivalent(list(c(x = 1), c(x = 1))) chk_all_equivalent(list(c(x = 1), c(y = 1))) # vld_all_equivalent vld_all_equivalent(c(x = 1, y = 1))
Checks all elements in x identical using
length(x) < 2L || all(vapply(x, vld_identical, TRUE, y = x[[1]]))
Pass: c(1, 1, 1), list(1, 1)
Fail: c(1, 1.0000001), list(1, NA)
chk_all_identical(x, x_name = NULL) vld_all_identical(x)chk_all_identical(x, x_name = NULL) vld_all_identical(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_all_identical(): Validate All Identical
Other chk_alls:
chk_all(),
chk_all_equal(),
chk_all_equivalent()
# chk_all_identical chk_all_identical(c(1, 1)) try(chk_all_identical(c(1, 1.1))) # vld_all_identical vld_all_identical(c(1, 1))# chk_all_identical chk_all_identical(c(1, 1)) try(chk_all_identical(c(1, 1.1))) # vld_all_identical vld_all_identical(c(1, 1))
Checks if is an array using
is.array(x)
chk_array(x, x_name = NULL) vld_array(x)chk_array(x, x_name = NULL) vld_array(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_array(): Validate Array
Other chk_is:
chk_atomic(),
chk_data(),
chk_function(),
chk_is(),
chk_matrix(),
chk_numeric(),
chk_s3_class(),
chk_s4_class(),
chk_vector(),
chk_whole_numeric()
# chk_array chk_array(array(1)) try(chk_array(matrix(1))) # vld_array vld_array(1) vld_array(array(1))# chk_array chk_array(array(1)) try(chk_array(matrix(1))) # vld_array vld_array(1) vld_array(array(1))
Checks if atomic using
is.atomic(x)
chk_atomic(x, x_name = NULL) vld_atomic(x)chk_atomic(x, x_name = NULL) vld_atomic(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_atomic(): Validate Atomic
Other chk_is:
chk_array(),
chk_data(),
chk_function(),
chk_is(),
chk_matrix(),
chk_numeric(),
chk_s3_class(),
chk_s4_class(),
chk_vector(),
chk_whole_numeric()
# chk_atomic chk_atomic(1) try(chk_atomic(list(1))) # vld_atomic vld_atomic(1) vld_atomic(matrix(1:3)) vld_atomic(character(0)) vld_atomic(list(1)) vld_atomic(NULL)# chk_atomic chk_atomic(1) try(chk_atomic(list(1))) # vld_atomic vld_atomic(1) vld_atomic(matrix(1:3)) vld_atomic(character(0)) vld_atomic(list(1)) vld_atomic(NULL)
Checks if character using
is.character(x)
chk_character(x, x_name = NULL) vld_character(x)chk_character(x, x_name = NULL) vld_character(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_character(): Validate Character
Other chk_typeof:
chk_character_or_factor(),
chk_count(),
chk_double(),
chk_environment(),
chk_factor(),
chk_integer(),
chk_list(),
chk_logical()
# chk_character chk_character("1") try(chk_character(1)) # vld_character vld_character("1") vld_character(matrix("a")) vld_character(character(0)) vld_character(NA_character_) vld_character(1) vld_character(TRUE) vld_character(factor("text"))# chk_character chk_character("1") try(chk_character(1)) # vld_character vld_character("1") vld_character(matrix("a")) vld_character(character(0)) vld_character(NA_character_) vld_character(1) vld_character(TRUE) vld_character(factor("text"))
Checks if character or factor using
is.character(x) || is.factor(x)
chk_character_or_factor(x, x_name = NULL) vld_character_or_factor(x)chk_character_or_factor(x, x_name = NULL) vld_character_or_factor(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_character_or_factor(): Validate Character or Factor
Other chk_typeof:
chk_character(),
chk_count(),
chk_double(),
chk_environment(),
chk_factor(),
chk_integer(),
chk_list(),
chk_logical()
# chk_character_or_factor chk_character_or_factor("1") chk_character_or_factor(factor("1")) try(chk_character(1)) # vld_character_or_factor vld_character_or_factor("1") vld_character_or_factor(matrix("a")) vld_character_or_factor(character(0)) vld_character_or_factor(NA_character_) vld_character_or_factor(1) vld_character_or_factor(TRUE) vld_character_or_factor(factor("text"))# chk_character_or_factor chk_character_or_factor("1") chk_character_or_factor(factor("1")) try(chk_character(1)) # vld_character_or_factor vld_character_or_factor("1") vld_character_or_factor(matrix("a")) vld_character_or_factor(character(0)) vld_character_or_factor(NA_character_) vld_character_or_factor(1) vld_character_or_factor(TRUE) vld_character_or_factor(factor("text"))
Checks if character scalar using
is.character(x) && length(x) == 1L
![[Deprecated]](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB3aWR0aD0iMTI0IiBoZWlnaHQ9IjIwIj48bGluZWFyR3JhZGllbnQgaWQ9ImIiIHgyPSIwIiB5Mj0iMTAwJSI+PHN0b3Agb2Zmc2V0PSIwIiBzdG9wLWNvbG9yPSIjYmJiIiBzdG9wLW9wYWNpdHk9Ii4xIi8+PHN0b3Agb2Zmc2V0PSIxIiBzdG9wLW9wYWNpdHk9Ii4xIi8+PC9saW5lYXJHcmFkaWVudD48Y2xpcFBhdGggaWQ9ImEiPjxyZWN0IHdpZHRoPSIxMjQiIGhlaWdodD0iMjAiIHJ4PSIzIiBmaWxsPSIjZmZmIi8+PC9jbGlwUGF0aD48ZyBjbGlwLXBhdGg9InVybCgjYSkiPjxwYXRoIGZpbGw9IiM1NTUiIGQ9Ik0wIDBoNTN2MjBIMHoiLz48cGF0aCBmaWxsPSIjZmU3ZDM3IiBkPSJNNTMgMGg3MXYyMEg1M3oiLz48cGF0aCBmaWxsPSJ1cmwoI2IpIiBkPSJNMCAwaDEyNHYyMEgweiIvPjwvZz48ZyBmaWxsPSIjZmZmIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmb250LWZhbWlseT0iRGVqYVZ1IFNhbnMsVmVyZGFuYSxHZW5ldmEsc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMTAiPjx0ZXh0IHg9IjI3NSIgeT0iMTUwIiBmaWxsPSIjMDEwMTAxIiBmaWxsLW9wYWNpdHk9Ii4zIiB0cmFuc2Zvcm09InNjYWxlKC4xKSIgdGV4dExlbmd0aD0iNDMwIj5saWZlY3ljbGU8L3RleHQ+PHRleHQgeD0iMjc1IiB5PSIxNDAiIHRyYW5zZm9ybT0ic2NhbGUoLjEpIiB0ZXh0TGVuZ3RoPSI0MzAiPmxpZmVjeWNsZTwvdGV4dD48dGV4dCB4PSI4NzUiIHk9IjE1MCIgZmlsbD0iIzAxMDEwMSIgZmlsbC1vcGFjaXR5PSIuMyIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIHRleHRMZW5ndGg9IjYxMCI+ZGVwcmVjYXRlZDwvdGV4dD48dGV4dCB4PSI4NzUiIHk9IjE0MCIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIHRleHRMZW5ndGg9IjYxMCI+ZGVwcmVjYXRlZDwvdGV4dD48L2c+IDwvc3ZnPg==)
chk_chr(x, x_name = NULL) vld_chr(x)chk_chr(x, x_name = NULL) vld_chr(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_chr(): Validate Character Scalar
Other deprecated:
chk_dbl(),
chk_deprecated,
chk_wnum()
chk_chr("a") try(chk_chr(1)) # vld_chr vld_chr("") vld_chr("a") vld_chr(NA_character_) vld_chr(c("a", "b")) vld_chr(1)chk_chr("a") try(chk_chr(1)) # vld_chr vld_chr("") vld_chr("a") vld_chr(NA_character_) vld_chr(c("a", "b")) vld_chr(1)
Checks objects (including vectors) have lengths that could be 'strictly recycled'. That is to say they must all be either zero length or the same length with some of length 1.
chk_compatible_lengths(..., x_name = NULL) vld_compatible_lengths(...)chk_compatible_lengths(..., x_name = NULL) vld_compatible_lengths(...)
... |
The objects to check for compatible lengths. |
x_name |
A string of the name of object x or NULL. |
This function helps to check vectors could be 'strictly recycled.' For example the function will error if you had a vector of length 2 and length 4, even though the vector of length 2 could be 'loosely recycled' to match up to the vector of length 4 when combined.
The intent of the function is to check that only strict recycling is occurring.
The chk_ function throws an informative error if the test fails.
vld_compatible_lengths(): Validate Compatible Lengths
# chk_compatible_lengths a <- integer(0) b <- numeric(0) chk_compatible_lengths(a, b) a <- 1 b <- 2 chk_compatible_lengths(a, b) a <- 1:3 b <- 1:3 chk_compatible_lengths(a, b) b <- 1 chk_compatible_lengths(a, b) b <- 1:2 try(chk_compatible_lengths(a, b)) b <- 1:6 try(chk_compatible_lengths(a, b)) # vld_compatible_lengths a <- integer(0) b <- numeric(0) vld_compatible_lengths(a, b) a <- 1 b <- 2 vld_compatible_lengths(a, b) a <- 1:3 b <- 1:3 vld_compatible_lengths(a, b) b <- 1 vld_compatible_lengths(a, b) b <- 1:2 vld_compatible_lengths(a, b) b <- 1:6 vld_compatible_lengths(a, b)# chk_compatible_lengths a <- integer(0) b <- numeric(0) chk_compatible_lengths(a, b) a <- 1 b <- 2 chk_compatible_lengths(a, b) a <- 1:3 b <- 1:3 chk_compatible_lengths(a, b) b <- 1 chk_compatible_lengths(a, b) b <- 1:2 try(chk_compatible_lengths(a, b)) b <- 1:6 try(chk_compatible_lengths(a, b)) # vld_compatible_lengths a <- integer(0) b <- numeric(0) vld_compatible_lengths(a, b) a <- 1 b <- 2 vld_compatible_lengths(a, b) a <- 1:3 b <- 1:3 vld_compatible_lengths(a, b) b <- 1 vld_compatible_lengths(a, b) b <- 1:2 vld_compatible_lengths(a, b) b <- 1:6 vld_compatible_lengths(a, b)
Checks if non-negative whole number using
vld_whole_number(x) && x >= 0
chk_count(x, x_name = NULL) vld_count(x)chk_count(x, x_name = NULL) vld_count(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_count(): Validate Count
Other chk_typeof:
chk_character(),
chk_character_or_factor(),
chk_double(),
chk_environment(),
chk_factor(),
chk_integer(),
chk_list(),
chk_logical()
# chk_count chk_count(1) try(chk_count(1.5)) # vld_count vld_count(1) vld_count(0L) vld_count(-1) vld_count(0.5)# chk_count chk_count(1) try(chk_count(1.5)) # vld_count vld_count(1) vld_count(0L) vld_count(-1) vld_count(0.5)
Checks data.frame using
inherits(x, "data.frame")
chk_data(x, x_name = NULL) vld_data(x)chk_data(x, x_name = NULL) vld_data(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_data(): Validate Data
Other chk_is:
chk_array(),
chk_atomic(),
chk_function(),
chk_is(),
chk_matrix(),
chk_numeric(),
chk_s3_class(),
chk_s4_class(),
chk_vector(),
chk_whole_numeric()
# chk_data chk_data(data.frame(x = 1)) try(chk_data(1)) # vld_data vld_data(data.frame()) vld_data(data.frame(x = 1)) vld_data(c(x = 1))# chk_data chk_data(data.frame(x = 1)) try(chk_data(1)) # vld_data vld_data(data.frame()) vld_data(data.frame(x = 1)) vld_data(c(x = 1))
Checks non-missing Date scalar using
inherits(x, "Date") && length(x) == 1L && !anyNA(x)
chk_date(x, x_name = NULL) vld_date(x)chk_date(x, x_name = NULL) vld_date(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_date(): Validate Date
Other chk_scalars:
chk_date_time(),
chk_number(),
chk_scalar(),
chk_string(),
chk_tz(),
chk_whole_number()
# chk_date chk_date(Sys.Date()) try(chk_date(1)) # vld_date vld_date(Sys.Date()) vld_date(Sys.time()) vld_date(1)# chk_date chk_date(Sys.Date()) try(chk_date(1)) # vld_date vld_date(Sys.Date()) vld_date(Sys.time()) vld_date(1)
Checks if non-missing POSIXct scalar using
inherits(x, "POSIXct") && length(x) == 1L && !anyNA(x)
chk_date_time(x, x_name = NULL) chk_datetime(x, x_name = NULL) vld_date_time(x) vld_datetime(x)chk_date_time(x, x_name = NULL) chk_datetime(x, x_name = NULL) vld_date_time(x) vld_datetime(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
chk_datetime(): Check Date Time (Deprecated)
vld_date_time(): Validate Date Time
vld_datetime(): Validate Date Time (Deprecated)
Other chk_scalars:
chk_date(),
chk_number(),
chk_scalar(),
chk_string(),
chk_tz(),
chk_whole_number()
# chk_date_time chk_date_time(as.POSIXct("2001-01-02")) try(chk_date_time(1)) # vld_date_time vld_date_time(as.POSIXct("2001-01-02")) vld_date_time(Sys.time()) vld_date_time(1) vld_date_time("2001-01-02") vld_date_time(c(Sys.time(), Sys.time()))# chk_date_time chk_date_time(as.POSIXct("2001-01-02")) try(chk_date_time(1)) # vld_date_time vld_date_time(as.POSIXct("2001-01-02")) vld_date_time(Sys.time()) vld_date_time(1) vld_date_time("2001-01-02") vld_date_time(c(Sys.time(), Sys.time()))
Checks if double scalar using
is.double(x) && length(x) == 1L
chk_dbl(x, x_name = NULL) vld_dbl(x)chk_dbl(x, x_name = NULL) vld_dbl(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_dbl(): Validate Double
Other deprecated:
chk_chr(),
chk_deprecated,
chk_wnum()
# chk_dbl chk_dbl(1) try(chk_dbl(1L)) # vld_dbl vld_dbl(1) vld_dbl(double(0)) vld_dbl(NA_real_) vld_dbl(c(1, 1)) vld_dbl(1L)# chk_dbl chk_dbl(1) try(chk_dbl(1L)) # vld_dbl vld_dbl(1) vld_dbl(double(0)) vld_dbl(NA_real_) vld_dbl(c(1, 1)) vld_dbl(1L)
Checks if directory exists using
vld_string(x) && dir.exists(x)
chk_dir(x, x_name = NULL) vld_dir(x)chk_dir(x, x_name = NULL) vld_dir(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_dir(): Validate Directory Exists
Other chk_files:
chk_ext(),
chk_file()
# chk_dir chk_dir(tempdir()) try(chk_dir(tempfile())) # vld_dir vld_dir(1) vld_dir(tempdir()) vld_dir(tempfile())# chk_dir chk_dir(tempdir()) try(chk_dir(tempfile())) # vld_dir vld_dir(1) vld_dir(tempdir()) vld_dir(tempfile())
Checks if double using
is.double(x)
chk_double(x, x_name = NULL) vld_double(x)chk_double(x, x_name = NULL) vld_double(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_double(): Validate Double
Other chk_typeof:
chk_character(),
chk_character_or_factor(),
chk_count(),
chk_environment(),
chk_factor(),
chk_integer(),
chk_list(),
chk_logical()
# chk_double chk_double(1) try(chk_double(1L)) # vld_double vld_double(1) vld_double(matrix(c(1, 2, 3, 4), nrow = 2L)) vld_double(double(0)) vld_double(numeric(0)) vld_double(NA_real_) vld_double(1L) vld_double(TRUE)# chk_double chk_double(1) try(chk_double(1L)) # vld_double vld_double(1) vld_double(matrix(c(1, 2, 3, 4), nrow = 2L)) vld_double(double(0)) vld_double(numeric(0)) vld_double(NA_real_) vld_double(1L) vld_double(TRUE)
Checks if environment using
is.environment(x)
chk_environment(x, x_name = NULL) vld_environment(x)chk_environment(x, x_name = NULL) vld_environment(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_environment(): Validate Environment
Other chk_typeof:
chk_character(),
chk_character_or_factor(),
chk_count(),
chk_double(),
chk_factor(),
chk_integer(),
chk_list(),
chk_logical()
# chk_environment chk_environment(.GlobalEnv) try(chk_environment(1)) # vld_environment vld_environment(1) vld_environment(list(1)) vld_environment(.GlobalEnv) vld_environment(environment())# chk_environment chk_environment(.GlobalEnv) try(chk_environment(1)) # vld_environment vld_environment(1) vld_environment(list(1)) vld_environment(.GlobalEnv) vld_environment(environment())
Checks if is equal (identical within tolerance) to y using
vld_true(all.equal(x, y, tolerance))
chk_equal(x, y, tolerance = sqrt(.Machine$double.eps), x_name = NULL) vld_equal(x, y, tolerance = sqrt(.Machine$double.eps))chk_equal(x, y, tolerance = sqrt(.Machine$double.eps), x_name = NULL) vld_equal(x, y, tolerance = sqrt(.Machine$double.eps))
x |
The object to check. |
y |
An object to check against. |
tolerance |
A non-negative numeric scalar. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_equal(): Validate Equal
Other chk_equals:
chk_equivalent(),
chk_identical()
# chk_equal chk_equal(1, 1.00000001) try(chk_equal(1, 1.0000001)) chk_equal(1, 1L) chk_equal(c(x = 1), c(x = 1L)) try(chk_equal(c(x = 1), c(y = 1L))) vld_equal(1, 1.00000001)# chk_equal chk_equal(1, 1.00000001) try(chk_equal(1, 1.0000001)) chk_equal(1, 1L) chk_equal(c(x = 1), c(x = 1L)) try(chk_equal(c(x = 1), c(y = 1L))) vld_equal(1, 1.00000001)
Checks if is equivalent (equal ignoring attributes) to y using
vld_true(all.equal(x, y, tolerance, check.attributes = FALSE))
chk_equivalent(x, y, tolerance = sqrt(.Machine$double.eps), x_name = NULL) vld_equivalent(x, y, tolerance = sqrt(.Machine$double.eps))chk_equivalent(x, y, tolerance = sqrt(.Machine$double.eps), x_name = NULL) vld_equivalent(x, y, tolerance = sqrt(.Machine$double.eps))
x |
The object to check. |
y |
An object to check against. |
tolerance |
A non-negative numeric scalar. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_equivalent(): Validate Equivalent
Other chk_equals:
chk_equal(),
chk_identical()
# chk_equivalent chk_equivalent(1, 1.00000001) try(chk_equivalent(1, 1.0000001)) chk_equivalent(1, 1L) chk_equivalent(c(x = 1), c(y = 1)) vld_equivalent(c(x = 1), c(y = 1L))# chk_equivalent chk_equivalent(1, 1.00000001) try(chk_equivalent(1, 1.0000001)) chk_equivalent(1, 1L) chk_equivalent(c(x = 1), c(y = 1)) vld_equivalent(c(x = 1), c(y = 1L))
Checks extension using
vld_string(x) && vld_subset(tools::file_ext(x), ext)
The user may want to use toupper() or tolower()
to ensure the case matches.
chk_ext(x, ext, x_name = NULL) vld_ext(x, ext)chk_ext(x, ext, x_name = NULL) vld_ext(x, ext)
x |
The object to check. |
ext |
A character vector of the permitted file extensions (without the .). |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_ext(): Validate File Extension
Other chk_files:
chk_dir(),
chk_file()
# chk_ext try(chk_ext("file1.pdf", "png")) # vld_ext vld_ext("oeu.pdf", "pdf") vld_ext(toupper("oeu.pdf"), "PDF")# chk_ext try(chk_ext("file1.pdf", "png")) # vld_ext vld_ext("oeu.pdf", "pdf") vld_ext(toupper("oeu.pdf"), "PDF")
Checks if factor using
is.factor(x)
chk_factor(x, x_name = NULL) vld_factor(x)chk_factor(x, x_name = NULL) vld_factor(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_factor(): Validate Factor
Other chk_typeof:
chk_character(),
chk_character_or_factor(),
chk_count(),
chk_double(),
chk_environment(),
chk_integer(),
chk_list(),
chk_logical()
# chk_factor chk_factor(factor("1")) try(chk_factor("1")) # vld_factor vld_factor(factor("1")) vld_factor(factor(0)) vld_factor("1") vld_factor(1L)# chk_factor chk_factor(factor("1")) try(chk_factor("1")) # vld_factor vld_factor(factor("1")) vld_factor(factor(0)) vld_factor("1") vld_factor(1L)
Check if FALSE using
is.logical(x) && length(x) == 1L && !anyNA(x) && !x
chk_false(x, x_name = NULL) vld_false(x)chk_false(x, x_name = NULL) vld_false(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_false(): Validate FALSE
Other chk_logical:
chk_flag(),
chk_lgl(),
chk_true()
# chk_false chk_false(FALSE) try(chk_false(0)) # vld_false vld_false(TRUE) vld_false(FALSE) vld_false(NA) vld_false(0) vld_false(c(FALSE, FALSE))# chk_false chk_false(FALSE) try(chk_false(0)) # vld_false vld_false(TRUE) vld_false(FALSE) vld_false(NA) vld_false(0) vld_false(c(FALSE, FALSE))
Checks if file exists using
vld_string(x) && file.exists(x) && !dir.exists(x)
chk_file(x, x_name = NULL) vld_file(x)chk_file(x, x_name = NULL) vld_file(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_file(): Validate File Exists
Other chk_files:
chk_dir(),
chk_ext()
# chk_file try(chk_file(tempfile())) # vld_file vld_file(tempfile())# chk_file try(chk_file(tempfile())) # vld_file vld_file(tempfile())
Checks if non-missing logical scalar using
is.logical(x) && length(x) == 1L && !anyNA(x)
Pass: TRUE, FALSE.
Fail: logical(0), c(TRUE, TRUE), "TRUE", 1, NA.
chk_flag(x, x_name = NULL) vld_flag(x)chk_flag(x, x_name = NULL) vld_flag(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_flag(): Validate Flag
Other chk_logical:
chk_false(),
chk_lgl(),
chk_true()
# chk_flag chk_flag(TRUE) try(vld_flag(1)) # vld_flag vld_flag(TRUE) vld_flag(1)# chk_flag chk_flag(TRUE) try(vld_flag(1)) # vld_flag vld_flag(TRUE) vld_flag(1)
Checks if is a function using
is.function(x) && (is.null(formals) || length(formals(x)) == formals)
chk_function(x, formals = NULL, x_name = NULL) vld_function(x, formals = NULL)chk_function(x, formals = NULL, x_name = NULL) vld_function(x, formals = NULL)
x |
The object to check. |
formals |
A count of the number of formal arguments. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_function(): Validate Function
Other chk_is:
chk_array(),
chk_atomic(),
chk_data(),
chk_is(),
chk_matrix(),
chk_numeric(),
chk_s3_class(),
chk_s4_class(),
chk_vector(),
chk_whole_numeric()
# chk_function chk_function(mean) try(chk_function(1)) # vld_function vld_function(mean) vld_function(function(x) x) vld_function(1) vld_function(list(1))# chk_function chk_function(mean) try(chk_function(1)) # vld_function vld_function(mean) vld_function(function(x) x) vld_function(1) vld_function(list(1))
Checks if all non-missing values are greater than value using
all(x[!is.na(x)] > value)
chk_gt(x, value = 0, x_name = NULL) vld_gt(x, value = 0)chk_gt(x, value = 0, x_name = NULL) vld_gt(x, value = 0)
x |
The object to check. |
value |
A non-missing scalar of a value. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_gt(): Validate Greater Than
Other chk_ranges:
chk_gte(),
chk_lt(),
chk_lte(),
chk_range()
# chk_gt chk_gt(0.1) try(chk_gt(c(0.1, -0.2))) # vld_gt vld_gt(numeric(0)) vld_gt(0) vld_gt(0.1) vld_gt(c(0.1, 0.2, NA)) vld_gt(c(0.1, -0.2)) vld_gt(c(-0.1, 0.2), value = -1) vld_gt("b", value = "a")# chk_gt chk_gt(0.1) try(chk_gt(c(0.1, -0.2))) # vld_gt vld_gt(numeric(0)) vld_gt(0) vld_gt(0.1) vld_gt(c(0.1, 0.2, NA)) vld_gt(c(0.1, -0.2)) vld_gt(c(-0.1, 0.2), value = -1) vld_gt("b", value = "a")
Checks if all non-missing values are greater than or equal to y using
all(x[!is.na(x)] >= value)
chk_gte(x, value = 0, x_name = NULL) vld_gte(x, value = 0)chk_gte(x, value = 0, x_name = NULL) vld_gte(x, value = 0)
x |
The object to check. |
value |
A non-missing scalar of a value. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_gte(): Validate Greater Than or Equal To
Other chk_ranges:
chk_gt(),
chk_lt(),
chk_lte(),
chk_range()
# chk_gte chk_gte(0) try(chk_gte(-0.1)) # vld_gte vld_gte(numeric(0)) vld_gte(0) vld_gte(-0.1) vld_gte(c(0.1, 0.2, NA)) vld_gte(c(0.1, 0.2, NA), value = 1)# chk_gte chk_gte(0) try(chk_gte(-0.1)) # vld_gte vld_gte(numeric(0)) vld_gte(0) vld_gte(-0.1) vld_gte(c(0.1, 0.2, NA)) vld_gte(c(0.1, 0.2, NA), value = 1)
Checks if is identical to y using
identical(x, y)
chk_identical(x, y, x_name = NULL) vld_identical(x, y)chk_identical(x, y, x_name = NULL) vld_identical(x, y)
x |
The object to check. |
y |
An object to check against. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_identical(): Validate Identical
Other chk_equals:
chk_equal(),
chk_equivalent()
# chk_identical chk_identical(1, 1) try(chk_identical(1, 1L)) chk_identical(c(1, 1), c(1, 1)) try(chk_identical(1, c(1, 1))) vld_identical(1, 1)# chk_identical chk_identical(1, 1) try(chk_identical(1, 1L)) chk_identical(c(1, 1), c(1, 1)) try(chk_identical(1, c(1, 1))) vld_identical(1, 1)
Checks if integer using
is.integer(x)
chk_integer(x, x_name = NULL) vld_integer(x)chk_integer(x, x_name = NULL) vld_integer(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_integer(): Validate Integer
Other chk_typeof:
chk_character(),
chk_character_or_factor(),
chk_count(),
chk_double(),
chk_environment(),
chk_factor(),
chk_list(),
chk_logical()
# chk_integer chk_integer(1L) try(chk_integer(1)) # vld_integer vld_integer(1L) vld_integer(matrix(1:4, nrow = 2L)) vld_integer(integer(0)) vld_integer(NA_integer_) vld_integer(1) vld_integer(TRUE)# chk_integer chk_integer(1L) try(chk_integer(1)) # vld_integer vld_integer(1L) vld_integer(matrix(1:4, nrow = 2L)) vld_integer(integer(0)) vld_integer(NA_integer_) vld_integer(1) vld_integer(TRUE)
Checks inherits from class using
inherits(x, class)
chk_is(x, class, x_name = NULL) vld_is(x, class)chk_is(x, class, x_name = NULL) vld_is(x, class)
x |
The object to check. |
class |
A string specifying the class. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_is(): Validate Inherits from Class
Other chk_is:
chk_array(),
chk_atomic(),
chk_data(),
chk_function(),
chk_matrix(),
chk_numeric(),
chk_s3_class(),
chk_s4_class(),
chk_vector(),
chk_whole_numeric()
chk_is(1, "numeric") try(chk_is(1L, "double")) # vld_is vld_is(numeric(0), "numeric") vld_is(1L, "double")chk_is(1, "numeric") try(chk_is(1L, "double")) # vld_is vld_is(numeric(0), "numeric") vld_is(1L, "double")
Checks if all rows in x match at least one in y.
chk_join(x, y, by, x_name = NULL) vld_join(x, y, by)chk_join(x, y, by, x_name = NULL) vld_join(x, y, by)
x |
The object to check. |
y |
A data.frame with columns in by. |
by |
A character vector specifying the column names to join x and y on. If named the names are the corresponding columns in x. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_join(): Validate Join
Other chk_set:
chk_not_subset(),
chk_orderset(),
chk_superset(),
vld_not_subset(),
vld_orderset()
# chk_join chk_join(data.frame(z = 1), data.frame(z = 1:2), by = "z") try(chk_join(data.frame(z = 1), data.frame(z = 2), by = "z")) # vld_join vld_join(data.frame(z = 1), data.frame(z = 1:2), by = "z") vld_join(data.frame(z = 1), data.frame(z = 2), by = "z") vld_join(data.frame(z = 1), data.frame(a = 1:2), by = c(z = "a")) vld_join(data.frame(z = 1), data.frame(a = 2), by = c(z = "a"))# chk_join chk_join(data.frame(z = 1), data.frame(z = 1:2), by = "z") try(chk_join(data.frame(z = 1), data.frame(z = 2), by = "z")) # vld_join vld_join(data.frame(z = 1), data.frame(z = 1:2), by = "z") vld_join(data.frame(z = 1), data.frame(z = 2), by = "z") vld_join(data.frame(z = 1), data.frame(a = 1:2), by = c(z = "a")) vld_join(data.frame(z = 1), data.frame(a = 2), by = c(z = "a"))
Checks length is a particular value or range using
length(x) >= length && length(x) <= upper
chk_length(x, length = 1L, upper = length, x_name = NULL) vld_length(x, length = 1L, upper = length)chk_length(x, length = 1L, upper = length, x_name = NULL) vld_length(x, length = 1L, upper = length)
x |
The object to check. |
length |
A count of the length. |
upper |
A count of the max length. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_length(): Validate Length
Other chk_misc:
chk_match(),
chk_missing(),
chk_named(),
chk_not_any_na(),
chk_not_empty(),
chk_not_missing(),
chk_sorted(),
chk_unique(),
chk_valid_name()
# chk_length chk_length("text") try(vld_length("text", length = 2)) # vld_length vld_length(2:1, 2) vld_length(2:1, 1)# chk_length chk_length("text") try(vld_length("text", length = 2)) # vld_length vld_length(2:1, 2) vld_length(2:1, 1)
Checks if logical scalar using
is.logical(x) && length(x) == 1L
chk_lgl(x, x_name = NULL) vld_lgl(x)chk_lgl(x, x_name = NULL) vld_lgl(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_lgl(): Validate Logical Scalar
Other chk_logical:
chk_false(),
chk_flag(),
chk_true()
# chk_lgl chk_lgl(NA) try(chk_lgl(1)) # vld_lgl vld_lgl(TRUE) vld_lgl(FALSE) vld_lgl(NA) vld_lgl(1) vld_lgl(c(TRUE, TRUE))# chk_lgl chk_lgl(NA) try(chk_lgl(1)) # vld_lgl vld_lgl(TRUE) vld_lgl(FALSE) vld_lgl(NA) vld_lgl(1) vld_lgl(c(TRUE, TRUE))
Checks if is a list using
is.list(x)
chk_list(x, x_name = NULL) vld_list(x)chk_list(x, x_name = NULL) vld_list(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_list(): Validate List
Other chk_typeof:
chk_character(),
chk_character_or_factor(),
chk_count(),
chk_double(),
chk_environment(),
chk_factor(),
chk_integer(),
chk_logical()
# chk_list chk_list(list()) try(chk_list(1)) # vld_list vld_list(list()) vld_list(list(x = 1)) vld_list(mtcars) vld_list(1) vld_list(NULL)# chk_list chk_list(list()) try(chk_list(1)) # vld_list vld_list(list()) vld_list(list(x = 1)) vld_list(mtcars) vld_list(1) vld_list(NULL)
Checks if logical using
is.logical(x)
chk_logical(x, x_name = NULL) vld_logical(x)chk_logical(x, x_name = NULL) vld_logical(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_logical(): Validate Logical
Other chk_typeof:
chk_character(),
chk_character_or_factor(),
chk_count(),
chk_double(),
chk_environment(),
chk_factor(),
chk_integer(),
chk_list()
# chk_logical chk_logical(TRUE) try(chk_logical(1)) # vld_logical vld_logical(TRUE) vld_logical(matrix(TRUE)) vld_logical(logical(0)) vld_logical(NA) vld_logical(1) vld_logical("TRUE")# chk_logical chk_logical(TRUE) try(chk_logical(1)) # vld_logical vld_logical(TRUE) vld_logical(matrix(TRUE)) vld_logical(logical(0)) vld_logical(NA) vld_logical(1) vld_logical("TRUE")
Checks if all non-missing values are less than value using
all(x[!is.na(x)] < value)
chk_lt(x, value = 0, x_name = NULL) vld_lt(x, value = 0)chk_lt(x, value = 0, x_name = NULL) vld_lt(x, value = 0)
x |
The object to check. |
value |
A non-missing scalar of a value. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_lt(): Validate Less Than
Other chk_ranges:
chk_gt(),
chk_gte(),
chk_lte(),
chk_range()
# chk_lt chk_lt(-0.1) try(chk_lt(c(-0.1, 0.2))) # vld_lt vld_lt(numeric(0)) vld_lt(0) vld_lt(-0.1) vld_lt(c(-0.1, -0.2, NA)) vld_lt(c(-0.1, 0.2)) vld_lt(c(-0.1, 0.2), value = 1) vld_lt("a", value = "b")# chk_lt chk_lt(-0.1) try(chk_lt(c(-0.1, 0.2))) # vld_lt vld_lt(numeric(0)) vld_lt(0) vld_lt(-0.1) vld_lt(c(-0.1, -0.2, NA)) vld_lt(c(-0.1, 0.2)) vld_lt(c(-0.1, 0.2), value = 1) vld_lt("a", value = "b")
Checks if all non-missing values are less than or equal to y using
all(x[!is.na(x)] <= value)
chk_lte(x, value = 0, x_name = NULL) vld_lte(x, value = 0)chk_lte(x, value = 0, x_name = NULL) vld_lte(x, value = 0)
x |
The object to check. |
value |
A non-missing scalar of a value. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_lte(): Validate Less Than or Equal To
Other chk_ranges:
chk_gt(),
chk_gte(),
chk_lt(),
chk_range()
# chk_lte chk_lte(0) try(chk_lte(0.1)) # vld_lte vld_lte(numeric(0)) vld_lte(0) vld_lte(0.1) vld_lte(c(-0.1, -0.2, NA)) vld_lte(c(-0.1, -0.2, NA), value = -1)# chk_lte chk_lte(0) try(chk_lte(0.1)) # vld_lte vld_lte(numeric(0)) vld_lte(0) vld_lte(0.1) vld_lte(c(-0.1, -0.2, NA)) vld_lte(c(-0.1, -0.2, NA), value = -1)
Checks if all values match regular expression using
all(grepl(regexp, x[!is.na(x)]))
chk_match(x, regexp = ".+", x_name = NULL) vld_match(x, regexp = ".+")chk_match(x, regexp = ".+", x_name = NULL) vld_match(x, regexp = ".+")
x |
The object to check. |
regexp |
A string of a regular expression. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_match(): Validate Matches
Other chk_misc:
chk_length(),
chk_missing(),
chk_named(),
chk_not_any_na(),
chk_not_empty(),
chk_not_missing(),
chk_sorted(),
chk_unique(),
chk_valid_name()
# chk_match chk_match("1") try(chk_match("1", regexp = "2")) # vld_match vld_match("1") vld_match("a", regexp = "a") vld_match("") vld_match("1", regexp = "2") vld_match(NA_character_, regexp = ".*")# chk_match chk_match("1") try(chk_match("1", regexp = "2")) # vld_match vld_match("1") vld_match("a", regexp = "a") vld_match("") vld_match("1", regexp = "2") vld_match(NA_character_, regexp = ".*")
Checks if is a matrix using
is.matrix(x)
chk_matrix(x, x_name = NULL) vld_matrix(x)chk_matrix(x, x_name = NULL) vld_matrix(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_matrix(): Validate Matrix
Other chk_is:
chk_array(),
chk_atomic(),
chk_data(),
chk_function(),
chk_is(),
chk_numeric(),
chk_s3_class(),
chk_s4_class(),
chk_vector(),
chk_whole_numeric()
# chk_matrix chk_matrix(matrix(1)) try(chk_matrix(array(1))) # vld_matrix vld_matrix(1) vld_matrix(matrix(1))# chk_matrix chk_matrix(matrix(1)) try(chk_matrix(array(1))) # vld_matrix vld_matrix(1) vld_matrix(matrix(1))
Checks argument missing using
missing(x)
chk_missing(x, x_name = NULL) vld_missing(x)chk_missing(x, x_name = NULL) vld_missing(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
Currently only checks if value is available (as opposed to whether it was specified).
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_missing(): Validate Missing Argument
Other chk_misc:
chk_length(),
chk_match(),
chk_named(),
chk_not_any_na(),
chk_not_empty(),
chk_not_missing(),
chk_sorted(),
chk_unique(),
chk_valid_name()
# chk_missing fun <- function(x) { chk_missing(x) } fun() try(fun(1)) # vld_missing fun <- function(x) { vld_missing(x) } fun() fun(1)# chk_missing fun <- function(x) { chk_missing(x) } fun() try(fun(1)) # vld_missing fun <- function(x) { vld_missing(x) } fun() fun(1)
Checks if is named using
!is.null(names(x))
chk_named(x, x_name = NULL) vld_named(x)chk_named(x, x_name = NULL) vld_named(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_named(): Validate Named
Other chk_misc:
chk_length(),
chk_match(),
chk_missing(),
chk_not_any_na(),
chk_not_empty(),
chk_not_missing(),
chk_sorted(),
chk_unique(),
chk_valid_name()
# chk_named chk_named(c(x = 1)) try(chk_named(list(1))) # vld_named vld_named(c(x = 1)) vld_named(list(x = 1)) vld_named(c(x = 1)[-1]) vld_named(list(x = 1)[-1]) vld_named(1) vld_named(list(1))# chk_named chk_named(c(x = 1)) try(chk_named(list(1))) # vld_named vld_named(c(x = 1)) vld_named(list(x = 1)) vld_named(c(x = 1)[-1]) vld_named(list(x = 1)[-1]) vld_named(1) vld_named(list(1))
Checks if not any missing values using
!anyNA(x)
Pass: 1, 1:2, "1", logical(0).
Fail: NA, c(1, NA).
chk_not_any_na(x, x_name = NULL) vld_not_any_na(x)chk_not_any_na(x, x_name = NULL) vld_not_any_na(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_not_any_na(): Validate Not Any Missing Values
Other chk_misc:
chk_length(),
chk_match(),
chk_missing(),
chk_named(),
chk_not_empty(),
chk_not_missing(),
chk_sorted(),
chk_unique(),
chk_valid_name()
# chk_not_any_na chk_not_any_na(1) try(chk_not_any_na(NA)) # vld_not_any_na vld_not_any_na(1) vld_not_any_na(1:2) vld_not_any_na(NA_real_) vld_not_any_na(integer(0)) vld_not_any_na(c(NA, 1)) vld_not_any_na(TRUE)# chk_not_any_na chk_not_any_na(1) try(chk_not_any_na(NA)) # vld_not_any_na vld_not_any_na(1) vld_not_any_na(1:2) vld_not_any_na(NA_real_) vld_not_any_na(integer(0)) vld_not_any_na(c(NA, 1)) vld_not_any_na(TRUE)
Checks if not empty using
length(x) != 0L
Pass: 1, 1:2, NA, matrix(1:3), list(1), data.frame(x = 1).
Fail: NULL, logical(0), list(), data.frame().
chk_not_empty(x, x_name = NULL) vld_not_empty(x)chk_not_empty(x, x_name = NULL) vld_not_empty(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_not_empty(): Validate Not Empty
Other chk_misc:
chk_length(),
chk_match(),
chk_missing(),
chk_named(),
chk_not_any_na(),
chk_not_missing(),
chk_sorted(),
chk_unique(),
chk_valid_name()
# chk_not_empty chk_not_empty(1) try(chk_not_empty(numeric(0))) # vld_not_empty vld_not_empty(1) vld_not_empty(matrix(1:3)) vld_not_empty(character(0)) vld_not_empty(list(1)) vld_not_empty(NULL) vld_not_empty(list())# chk_not_empty chk_not_empty(1) try(chk_not_empty(numeric(0))) # vld_not_empty vld_not_empty(1) vld_not_empty(matrix(1:3)) vld_not_empty(character(0)) vld_not_empty(list(1)) vld_not_empty(NULL) vld_not_empty(list())
Checks argument not missing using
!missing(x)
chk_not_missing(x, x_name = "`x`") vld_not_missing(x)chk_not_missing(x, x_name = "`x`") vld_not_missing(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
Currently only checks if value is available (as opposed to whether it was specified).
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_not_missing(): Validate Not Missing Argument
Other chk_misc:
chk_length(),
chk_match(),
chk_missing(),
chk_named(),
chk_not_any_na(),
chk_not_empty(),
chk_sorted(),
chk_unique(),
chk_valid_name()
# chk_not_missing fun <- function(x) { chk_not_missing(x) } fun(1) try(fun()) # vld_not_missing fun <- function(x) { vld_not_missing(x) } fun() fun(1)# chk_not_missing fun <- function(x) { chk_not_missing(x) } fun(1) try(fun()) # vld_not_missing fun <- function(x) { vld_not_missing(x) } fun() fun(1)
Checks if not NULL using
!is.null(x)
chk_not_null(x, x_name = NULL) vld_not_null(x)chk_not_null(x, x_name = NULL) vld_not_null(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_not_null(): Validate Not NULL
Other chk_nulls:
chk_null()
# chk_not_null try(chk_not_null(NULL)) chk_not_null(1) # vld_not_null vld_not_null(1) vld_not_null(NULL)# chk_not_null try(chk_not_null(NULL)) chk_not_null(1) # vld_not_null vld_not_null(1) vld_not_null(NULL)
Checks if not all values in values using
!any(x %in% values) || !length(x)
chk_not_subset(x, values, x_name = NULL)chk_not_subset(x, values, x_name = NULL)
x |
The object to check. |
values |
A vector of the permitted values. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
Other chk_set:
chk_join(),
chk_orderset(),
chk_superset(),
vld_not_subset(),
vld_orderset()
# chk_not_subset chk_not_subset(11, 1:10) try(chk_not_subset(1, 1:10))# chk_not_subset chk_not_subset(11, 1:10) try(chk_not_subset(1, 1:10))
Checks if NULL using
is.null(x)
chk_null(x, x_name = NULL) vld_null(x)chk_null(x, x_name = NULL) vld_null(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_null(): Validate NULL
Other chk_nulls:
chk_not_null()
# chk_null try(chk_null(1)) chk_null(NULL) # vld_null vld_null(NULL) vld_null(1)# chk_null try(chk_null(1)) chk_null(NULL) # vld_null vld_null(NULL) vld_null(1)
Checks if NULL or passes test.
chk_null_or(x, chk, ..., vld, x_name = NULL)chk_null_or(x, chk, ..., vld, x_name = NULL)
x |
The object to check. |
chk |
A chk function. Soft-deprecated for vld. |
... |
Arguments passed to chk. |
vld |
A vld function. |
x_name |
A string of the name of object x or NULL. |
An informative error if the test fails.
chk_null_or(NULL, chk_number) chk_null_or(1, chk_number) try(chk_null_or("1", chk_number))chk_null_or(NULL, chk_number) chk_null_or(1, chk_number) try(chk_null_or("1", chk_number))
Checks if non-missing numeric scalar using
is.numeric(x) && length(x) == 1L && !anyNA(x)
Pass: 1, 2L, log(10), -Inf
Fail: "a", 1:3, NA_real_
chk_number(x, x_name = NULL) vld_number(x)chk_number(x, x_name = NULL) vld_number(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_number(): Validate Number
Other chk_scalars:
chk_date(),
chk_date_time(),
chk_scalar(),
chk_string(),
chk_tz(),
chk_whole_number()
# chk_number chk_number(1.1) try(chk_number(TRUE)) # vld_number vld_number(1.1)# chk_number chk_number(1.1) try(chk_number(TRUE)) # vld_number vld_number(1.1)
Checks if numeric using
is.numeric(x)
Pass: 1, 1:2, NA_real_, integer(0), matrix(1:3).
Fail: TRUE, "1", NA, NULL.
chk_numeric(x, x_name = NULL) vld_numeric(x)chk_numeric(x, x_name = NULL) vld_numeric(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_numeric(): Validate Numeric
Other chk_is:
chk_array(),
chk_atomic(),
chk_data(),
chk_function(),
chk_is(),
chk_matrix(),
chk_s3_class(),
chk_s4_class(),
chk_vector(),
chk_whole_numeric()
# chk_numeric chk_numeric(1) try(chk_numeric("1")) # vld_numeric vld_numeric(1) vld_numeric(1:2) vld_numeric(NA_real_) vld_numeric(integer(0)) vld_numeric("1") vld_numeric(TRUE)# chk_numeric chk_numeric(1) try(chk_numeric("1")) # vld_numeric vld_numeric(1) vld_numeric(1:2) vld_numeric(NA_real_) vld_numeric(integer(0)) vld_numeric("1") vld_numeric(TRUE)
Checks if the first occurrence of each shared element
in x is equivalent to the first occurrence of each shared element in values using
vld_equivalent(unique(x[x %in% values]), values[values %in% x]).
chk_orderset(x, values, x_name = NULL)chk_orderset(x, values, x_name = NULL)
x |
The object to check. |
values |
A vector of the permitted values. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails.
The vld_ function returns a flag indicating whether the test was met.
Other chk_set:
chk_join(),
chk_not_subset(),
chk_superset(),
vld_not_subset(),
vld_orderset()
# chk_orderset chk_orderset(1:2, 1:2) try(chk_orderset(2:1, 1:2))# chk_orderset chk_orderset(1:2, 1:2) try(chk_orderset(2:1, 1:2))
Checks all non-missing values fall within range using
If inclusive
all(x[!is.na(x)] >= range[1] & x[!is.na(x)] <= range[2])
else
all(x[!is.na(x)] > range[1] & x[!is.na(x)] < range[2])
chk_range(x, range = c(0, 1), inclusive = TRUE, x_name = NULL) vld_range(x, range = c(0, 1), inclusive = TRUE)chk_range(x, range = c(0, 1), inclusive = TRUE, x_name = NULL) vld_range(x, range = c(0, 1), inclusive = TRUE)
x |
The object to check. |
range |
A non-missing sorted vector of length 2 of the lower and upper permitted values. |
inclusive |
A flag specifying whether the range is exclusive. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_range(): Validate Range
Other chk_ranges:
chk_gt(),
chk_gte(),
chk_lt(),
chk_lte()
# chk_range chk_range(0) try(chk_range(-0.1)) # vld_range vld_range(numeric(0)) vld_range(0) vld_range(-0.1) vld_range(c(0.1, 0.2, NA)) vld_range(c(0.1, 0.2, NA), range = c(0, 1))# chk_range chk_range(0) try(chk_range(-0.1)) # vld_range vld_range(numeric(0)) vld_range(0) vld_range(-0.1) vld_range(c(0.1, 0.2, NA)) vld_range(c(0.1, 0.2, NA), range = c(0, 1))
Checks inherits from S3 class using
!isS4(x) && inherits(x, class)
chk_s3_class(x, class, x_name = NULL) vld_s3_class(x, class)chk_s3_class(x, class, x_name = NULL) vld_s3_class(x, class)
x |
The object to check. |
class |
A string specifying the class. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_s3_class(): Validate Inherits from S3 Class
Other chk_is:
chk_array(),
chk_atomic(),
chk_data(),
chk_function(),
chk_is(),
chk_matrix(),
chk_numeric(),
chk_s4_class(),
chk_vector(),
chk_whole_numeric()
# chk_s3_class chk_s3_class(1, "numeric") try(chk_s3_class(getClass("MethodDefinition"), "classRepresentation")) # vld_s3_class vld_s3_class(numeric(0), "numeric") vld_s3_class(getClass("MethodDefinition"), "classRepresentation")# chk_s3_class chk_s3_class(1, "numeric") try(chk_s3_class(getClass("MethodDefinition"), "classRepresentation")) # vld_s3_class vld_s3_class(numeric(0), "numeric") vld_s3_class(getClass("MethodDefinition"), "classRepresentation")
Checks inherits from S4 class using
isS4(x) && methods::is(x, class)
chk_s4_class(x, class, x_name = NULL) vld_s4_class(x, class)chk_s4_class(x, class, x_name = NULL) vld_s4_class(x, class)
x |
The object to check. |
class |
A string specifying the class. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_s4_class(): Validate Inherits from S4 Class
Other chk_is:
chk_array(),
chk_atomic(),
chk_data(),
chk_function(),
chk_is(),
chk_matrix(),
chk_numeric(),
chk_s3_class(),
chk_vector(),
chk_whole_numeric()
# chk_s4_class try(chk_s4_class(1, "numeric")) chk_s4_class(getClass("MethodDefinition"), "classRepresentation") # vld_s4_class vld_s4_class(numeric(0), "numeric") vld_s4_class(getClass("MethodDefinition"), "classRepresentation")# chk_s4_class try(chk_s4_class(1, "numeric")) chk_s4_class(getClass("MethodDefinition"), "classRepresentation") # vld_s4_class vld_s4_class(numeric(0), "numeric") vld_s4_class(getClass("MethodDefinition"), "classRepresentation")
Checks if is a vector using
length(x) == 1L
chk_scalar(x, x_name = NULL) vld_scalar(x)chk_scalar(x, x_name = NULL) vld_scalar(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_scalar(): Validate Scalar
Other chk_scalars:
chk_date(),
chk_date_time(),
chk_number(),
chk_string(),
chk_tz(),
chk_whole_number()
# chk_scalar chk_scalar(1) chk_scalar(list(1)) try(chk_scalar(1:2)) # vld_scalar vld_scalar(1)# chk_scalar chk_scalar(1) chk_scalar(list(1)) try(chk_scalar(1:2)) # vld_scalar vld_scalar(1)
Checks if is sorted using
is.unsorted(x, na.rm = TRUE)
chk_sorted(x, x_name = NULL) vld_sorted(x)chk_sorted(x, x_name = NULL) vld_sorted(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_sorted(): Validate Sorted
Other chk_misc:
chk_length(),
chk_match(),
chk_missing(),
chk_named(),
chk_not_any_na(),
chk_not_empty(),
chk_not_missing(),
chk_unique(),
chk_valid_name()
# chk_sorted chk_sorted(1:2) try(chk_sorted(2:1)) # vld_sorted vld_sorted(1:2) vld_sorted(2:1)# chk_sorted chk_sorted(1:2) try(chk_sorted(2:1)) # vld_sorted vld_sorted(1:2) vld_sorted(2:1)
Checks if string
is.character(x) && length(x) == 1L && !anyNA(x)
chk_string(x, x_name = NULL) vld_string(x)chk_string(x, x_name = NULL) vld_string(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_string(): Validate String
Other chk_scalars:
chk_date(),
chk_date_time(),
chk_number(),
chk_scalar(),
chk_tz(),
chk_whole_number()
# chk_string chk_string("1") try(chk_string(1)) # vld_string vld_string("1") vld_string("") vld_string(1) vld_string(NA_character_) vld_string(c("1", "1"))# chk_string chk_string("1") try(chk_string(1)) # vld_string vld_string("1") vld_string("") vld_string(1) vld_string(NA_character_) vld_string(c("1", "1"))
Checks if includes all values using
all(values %in% x)
chk_superset(x, values, x_name = NULL) vld_superset(x, values)chk_superset(x, values, x_name = NULL) vld_superset(x, values)
x |
The object to check. |
values |
A vector of the permitted values. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_superset(): Validates Superset
Other chk_set:
chk_join(),
chk_not_subset(),
chk_orderset(),
vld_not_subset(),
vld_orderset()
# chk_superset chk_superset(1:3, 1) try(chk_superset(1:3, 4)) # vld_superset vld_superset(1:3, 1) vld_superset(1:3, 4) vld_superset(integer(0), integer(0))# chk_superset chk_superset(1:3, 1) try(chk_superset(1:3, 4)) # vld_superset vld_superset(1:3, 1) vld_superset(1:3, 4) vld_superset(integer(0), integer(0))
Checks if TRUE using
is.logical(x) && length(x) == 1L && !anyNA(x) && x
chk_true(x, x_name = NULL) vld_true(x)chk_true(x, x_name = NULL) vld_true(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_true(): Validate TRUE
Other chk_logical:
chk_false(),
chk_flag(),
chk_lgl()
# chk_true chk_true(TRUE) try(chk_true(1)) # vld_true vld_true(TRUE) vld_true(FALSE) vld_true(NA) vld_true(0) vld_true(c(TRUE, TRUE))# chk_true chk_true(TRUE) try(chk_true(1)) # vld_true vld_true(TRUE) vld_true(FALSE) vld_true(NA) vld_true(0) vld_true(c(TRUE, TRUE))
Checks if non-missing valid scalar timezone using
is.character(x) && length(x) == 1L && !anyNA(x) && x %in% OlsonNames()
chk_tz(x, x_name = NULL) vld_tz(x)chk_tz(x, x_name = NULL) vld_tz(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_tz(): Validate Time Zone
Other chk_scalars:
chk_date(),
chk_date_time(),
chk_number(),
chk_scalar(),
chk_string(),
chk_whole_number()
chk_tz("UTC") try(chk_tz("TCU")) vld_tz("UTC") vld_tz("TCU")chk_tz("UTC") try(chk_tz("TCU")) vld_tz("UTC") vld_tz("TCU")
Checks if unique using
!anyDuplicated(x, incomparables = incomparables)
chk_unique(x, incomparables = FALSE, x_name = NULL) vld_unique(x, incomparables = FALSE)chk_unique(x, incomparables = FALSE, x_name = NULL) vld_unique(x, incomparables = FALSE)
x |
The object to check. |
incomparables |
A vector of values that cannot be compared. FALSE means that all values can be compared. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_unique(): Validate Unique
Other chk_misc:
chk_length(),
chk_match(),
chk_missing(),
chk_named(),
chk_not_any_na(),
chk_not_empty(),
chk_not_missing(),
chk_sorted(),
chk_valid_name()
# chk_unique chk_unique(c(NA, 2)) try(chk_unique(c(NA, NA, 2))) chk_unique(c(NA, NA, 2), incomparables = NA) # vld_unique vld_unique(NULL) vld_unique(numeric(0)) vld_unique(c(NA, 2)) vld_unique(c(NA, NA, 2)) vld_unique(c(NA, NA, 2), incomparables = NA)# chk_unique chk_unique(c(NA, 2)) try(chk_unique(c(NA, NA, 2))) chk_unique(c(NA, NA, 2), incomparables = NA) # vld_unique vld_unique(NULL) vld_unique(numeric(0)) vld_unique(c(NA, 2)) vld_unique(c(NA, NA, 2)) vld_unique(c(NA, NA, 2), incomparables = NA)
Checks if ... is unused
length(list(...)) == 0L
chk_unused(...) vld_unused(...)chk_unused(...) vld_unused(...)
... |
Additional arguments. |
The chk_ function throws an informative error if the test fails.
vld_unused(): Validate ... Unused
Other chk_ellipsis:
chk_used()
# chk_unused fun <- function(x, ...) { chk_unused(...) x } fun(1) try(fun(1, 2)) # vld_unused fun <- function(x, ...) { vld_unused(...) } fun(1) try(fun(1, 2))# chk_unused fun <- function(x, ...) { chk_unused(...) x } fun(1) try(fun(1, 2)) # vld_unused fun <- function(x, ...) { vld_unused(...) } fun(1) try(fun(1, 2))
Checks if is ... used using
length(list(...)) != 0L
chk_used(...) vld_used(...)chk_used(...) vld_used(...)
... |
Additional arguments. |
The chk_ function throws an informative error if the test fails.
vld_used(): Validate ... Used
Other chk_ellipsis:
chk_unused()
# chk_used fun <- function(x, ...) { chk_used(...) x } try(fun(1)) fun(1, 2) # vld_used fun <- function(x, ...) { vld_used(...) } fun(1) fun(1, 2)# chk_used fun <- function(x, ...) { chk_used(...) x } try(fun(1)) fun(1, 2) # vld_used fun <- function(x, ...) { vld_used(...) } fun(1) fun(1, 2)
Checks if valid name using
identical(make.names(x[!is.na(x)]), as.character(x[!is.na(x)]))
chk_valid_name(x, x_name = NULL) vld_valid_name(x)chk_valid_name(x, x_name = NULL) vld_valid_name(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_valid_name(): Validate Valid Name
Other chk_misc:
chk_length(),
chk_match(),
chk_missing(),
chk_named(),
chk_not_any_na(),
chk_not_empty(),
chk_not_missing(),
chk_sorted(),
chk_unique()
# chk_valid_name chk_valid_name("text") try(chk_valid_name(".1")) # vld_valid_name vld_valid_name(".1")# chk_valid_name chk_valid_name("text") try(chk_valid_name(".1")) # vld_valid_name vld_valid_name(".1")
Checks if is a vector using
(is.atomic(x) && !is.matrix(x) && !is.array(x)) || is.list(x)
chk_vector(x, x_name = NULL) vld_vector(x)chk_vector(x, x_name = NULL) vld_vector(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
is.vector(x) is not reliable because it returns TRUE only
if the object is a vector with no attributes apart from names.
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_vector(): Validate Vector
Other chk_is:
chk_array(),
chk_atomic(),
chk_data(),
chk_function(),
chk_is(),
chk_matrix(),
chk_numeric(),
chk_s3_class(),
chk_s4_class(),
chk_whole_numeric()
# chk_vector chk_vector(1) chk_vector(list()) try(chk_vector(matrix(1))) # vld_vector vld_vector(1)# chk_vector chk_vector(1) chk_vector(list()) try(chk_vector(matrix(1))) # vld_vector vld_vector(1)
Checks if non-missing integer scalar or double equivalent using
vld_number(x) && (is.integer(x) || vld_true(all.equal(x, trunc(x))))
Pass: 1, 2L, 1e10, -Inf
Fail: "a", 1:3, NA_integer_, log(10)
chk_whole_number(x, x_name = NULL) vld_whole_number(x)chk_whole_number(x, x_name = NULL) vld_whole_number(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_whole_number(): Validate Whole Number
Other chk_scalars:
chk_date(),
chk_date_time(),
chk_number(),
chk_scalar(),
chk_string(),
chk_tz()
# chk_whole_number chk_whole_number(2) try(chk_whole_number(1.1)) # vld_whole_number vld_whole_number(2)# chk_whole_number chk_whole_number(2) try(chk_whole_number(1.1)) # vld_whole_number vld_whole_number(2)
Checks if integer vector or double equivalent using
is.integer(x) || (is.double(x) && vld_true(all.equal(x, as.integer(x))))
chk_whole_numeric(x, x_name = NULL) vld_whole_numeric(x)chk_whole_numeric(x, x_name = NULL) vld_whole_numeric(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_whole_numeric(): Validate Whole Numeric
Other chk_is:
chk_array(),
chk_atomic(),
chk_data(),
chk_function(),
chk_is(),
chk_matrix(),
chk_numeric(),
chk_s3_class(),
chk_s4_class(),
chk_vector()
# chk_whole_numeric chk_whole_numeric(1) try(chk_whole_numeric(1.1)) # vld_whole_numeric vld_whole_numeric(1) vld_whole_numeric(NA_real_) vld_whole_numeric(1:2) vld_whole_numeric(double(0)) vld_whole_numeric(TRUE) vld_whole_numeric(1.5)# chk_whole_numeric chk_whole_numeric(1) try(chk_whole_numeric(1.1)) # vld_whole_numeric vld_whole_numeric(1) vld_whole_numeric(NA_real_) vld_whole_numeric(1:2) vld_whole_numeric(double(0)) vld_whole_numeric(TRUE) vld_whole_numeric(1.5)
Checks if whole numeric scalar using
is.numeric(x) && length(x) == 1L && (is.integer(x) || vld_true(all.equal(x, trunc(x))))
chk_wnum(x, x_name = NULL) vld_wnum(x)chk_wnum(x, x_name = NULL) vld_wnum(x)
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_wnum(): Validate Whole Numeric Scalar
Other deprecated:
chk_chr(),
chk_dbl(),
chk_deprecated
# chk_wnum chk_wnum(1) try(chk_wnum(1.1)) # vld_wnum vld_wnum(1) vld_wnum(double(0)) vld_wnum(NA_real_) vld_wnum(c(1, 1)) vld_wnum(1L)# chk_wnum chk_wnum(1) try(chk_wnum(1.1)) # vld_wnum vld_wnum(1) vld_wnum(double(0)) vld_wnum(NA_real_) vld_wnum(c(1, 1)) vld_wnum(1L)
The chkor() function has been deprecated for the faster chkor_vld().
chkor(...)chkor(...)
... |
Multiple |
An informative error if the test fails.
chkor() chkor(chk_flag(TRUE)) try(chkor(chk_flag(1))) try(chkor(chk_flag(1), chk_flag(2))) chkor(chk_flag(1), chk_flag(TRUE))chkor() chkor(chk_flag(TRUE)) try(chkor(chk_flag(1))) try(chkor(chk_flag(1), chk_flag(2))) chkor(chk_flag(1), chk_flag(TRUE))
Chk OR
chkor_vld(...)chkor_vld(...)
... |
Multiple A common mistake is to pass
|
An informative error if the test fails.
chkor_vld() chkor_vld(vld_flag(TRUE)) try(chkor_vld(vld_flag(1))) try(chkor_vld(vld_flag(1), vld_flag(2))) chkor_vld(vld_flag(1), vld_flag(TRUE))chkor_vld() chkor_vld(vld_flag(TRUE)) try(chkor_vld(vld_flag(1))) try(chkor_vld(vld_flag(1), vld_flag(2))) chkor_vld(vld_flag(1), vld_flag(TRUE))
deparse_backtick_chk is a wrapper on deparse()
and backtick_chk.
deparse_backtick_chk(x) backtick_chk(x) unbacktick_chk(x)deparse_backtick_chk(x) backtick_chk(x) unbacktick_chk(x)
x |
A substituted object to deparse. |
It is exported to allow users to easily construct their own chk_ functions.
A string of the backticked substituted object.
backtick_chk(): Backtick
unbacktick_chk(): Unbacktick
# deparse_backtick_chk deparse_backtick_chk(2) deparse_backtick_chk(2^2)# deparse_backtick_chk deparse_backtick_chk(2) deparse_backtick_chk(2^2)
The functions call message_chk() to process
the message and then
rlang::abort(), rlang::warn() and
rlang::inform(), respectively.
err( ..., n = NULL, tidy = TRUE, .subclass = NULL, class = NULL, call = rlang::caller_call(3) ) wrn(..., n = NULL, tidy = TRUE, .subclass = NULL, class = NULL) msg(..., n = NULL, tidy = TRUE, .subclass = NULL, class = NULL)err( ..., n = NULL, tidy = TRUE, .subclass = NULL, class = NULL, call = rlang::caller_call(3) ) wrn(..., n = NULL, tidy = TRUE, .subclass = NULL, class = NULL) msg(..., n = NULL, tidy = TRUE, .subclass = NULL, class = NULL)
... |
zero or more objects which can be coerced to character (and which are pasted together with no separator) or a single condition object. |
n |
The value of n for converting |
tidy |
A flag specifying whether capitalize the first character and add a missing period. |
.subclass |
A string of the class of the error message. |
class |
Subclass of the condition. |
call |
The execution environment of a currently running
function, e.g. You only need to supply Can also be For more information about error calls, see Including function calls in error messages. |
The user can set the subclass.
err(): Error
wrn(): Warning
msg(): Message
# err try(err("there %r %n problem value%s", n = 2)) # wrn wrn("there %r %n problem value%s", n = 2) # msg msg("there %r %n problem value%s", n = 2)# err try(err("there %r %n problem value%s", n = 2)) # wrn wrn("there %r %n problem value%s", n = 2) # msg msg("there %r %n problem value%s", n = 2)
expect_chk_error() checks that code throws an error
of class "chk_error" with a message that matches regexp.
See below for more details.
expect_chk_error( object, regexp = NULL, ..., info = NULL, label = NULL, class = NULL )expect_chk_error( object, regexp = NULL, ..., info = NULL, label = NULL, class = NULL )
object |
Object to test. Supports limited unquoting to make it easier to generate readable failures within a function or for loop. See quasi_label for more details. |
regexp |
Regular expression to test against.
Note that you should only use |
... |
Arguments passed on to
|
info |
Extra information to be included in the message. This argument is soft-deprecated and should not be used in new code. Instead see alternatives in quasi_label. |
label |
Used to customise failure messages. For expert use only. |
class |
Must be NULL. |
If regexp = NA, the value of the first argument; otherwise
the captured condition.
message vs class
When checking that code generates an error, it's important to check that the
error is the one you expect. There are two ways to do this. The first
way is the simplest: you just provide a regexp that match some fragment
of the error message. This is easy, but fragile, because the test will
fail if the error message changes (even if its the same error).
A more robust way is to test for the class of the error, if it has one.
You can learn more about custom conditions at
https://adv-r.hadley.nz/conditions.html#custom-conditions, but in
short, errors are S3 classes and you can generate a custom class and check
for it using class instead of regexp.
If you are using expect_error() to check that an error message is
formatted in such a way that it makes sense to a human, we recommend
using expect_snapshot() instead.
expect_no_error(), expect_no_warning(),
expect_no_message(), and expect_no_condition() to assert
that code runs without errors/warnings/messages/conditions.
Other expectations:
comparison-expectations,
equality-expectations,
expect_length(),
expect_match(),
expect_named(),
expect_null(),
expect_output(),
expect_reference(),
expect_silent(),
inheritance-expectations,
logical-expectations
expect_chk_error(chk_true(FALSE)) try(expect_chk_error(chk_false(FALSE)))expect_chk_error(chk_true(FALSE)) try(expect_chk_error(chk_false(FALSE)))
If tidy = TRUE constructs a tidyverse style message by
message_chk(..., n = NULL, tidy = TRUE)message_chk(..., n = NULL, tidy = TRUE)
... |
Multiple objects that are converted to a string using
|
n |
The value of n for converting |
tidy |
A flag specifying whether capitalize the first character and add a missing period. |
Capitalizing the first character if possible.
Adding a trailing . if missing.
Also if n != NULL replaces the recognized sprintf-like types.
A string of the message.
sprintf-like typesThe following recognized sprintf-like types can be used in a message:
nThe value of n.
s” if n == 1 otherwise 's'
r'is' if n == 1 otherwise 'are'
y'y' if n == 1 otherwise 'ie'
message_chk("there %r %n", " problem director%y%s") message_chk("there %r %n", " problem director%y%s", n = 1) message_chk("There %r %n", " problem director%y%s.", n = 3)message_chk("there %r %n", " problem director%y%s") message_chk("there %r %n", " problem director%y%s", n = 1) message_chk("There %r %n", " problem director%y%s.", n = 3)
A wrapper on base::paste().
p(..., sep = " ", collapse = NULL) p0(..., collapse = NULL)p(..., sep = " ", collapse = NULL) p0(..., collapse = NULL)
... |
one or more R objects, to be converted to character vectors. |
sep |
a character string to separate the terms. Not
|
collapse |
an optional character string to separate the results. Not
|
A character vector.
p0(): A wrapper on base::paste0()
p("a", "b") p(c("a", "b"), collapse = " ") p0("a", "b") p0(c("a", "b"), collapse = "")p("a", "b") p(c("a", "b"), collapse = " ") p0("a", "b") p0(c("a", "b"), collapse = "")
Checks if all values in values using
all(x %in% values)
vld_not_subset(x, values) chk_subset(x, values, x_name = NULL) vld_subset(x, values)vld_not_subset(x, values) chk_subset(x, values, x_name = NULL) vld_subset(x, values)
x |
The object to check. |
values |
A vector of the permitted values. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_not_subset(): Validate Not Subset
vld_subset(): Validate Subset
Other chk_set:
chk_join(),
chk_not_subset(),
chk_orderset(),
chk_superset(),
vld_orderset()
# vld_not_subset vld_not_subset(numeric(0), 1:10) vld_not_subset(1, 1:10) vld_not_subset(11, 1:10) # chk_subset chk_subset(1, 1:10) try(chk_subset(11, 1:10)) # vld_subset vld_subset(numeric(0), 1:10) vld_subset(1, 1:10) vld_subset(11, 1:10)# vld_not_subset vld_not_subset(numeric(0), 1:10) vld_not_subset(1, 1:10) vld_not_subset(11, 1:10) # chk_subset chk_subset(1, 1:10) try(chk_subset(11, 1:10)) # vld_subset vld_subset(numeric(0), 1:10) vld_subset(1, 1:10) vld_subset(11, 1:10)
Checks if equal set using
setequal(x, values)
vld_orderset(x, values) chk_setequal(x, values, x_name = NULL) vld_setequal(x, values)vld_orderset(x, values) chk_setequal(x, values, x_name = NULL) vld_setequal(x, values)
x |
The object to check. |
values |
A vector of the permitted values. |
x_name |
A string of the name of object x or NULL. |
The chk_ function throws an informative error if the test fails or
returns the original object if successful so it can used in pipes.
The vld_ function returns a flag indicating whether the test was met.
vld_orderset(): Validate Set Ordered
vld_setequal(): Validate Set Equal
Other chk_set:
chk_join(),
chk_not_subset(),
chk_orderset(),
chk_superset(),
vld_not_subset()
# vld_orderset vld_orderset(1, 1) vld_orderset(1:2, 2:1) vld_orderset(1, 2:1) vld_orderset(1:2, 2) # chk_setequal chk_setequal(1:2, 2:1) try(chk_setequal(1, 1:2)) # vld_setequal vld_setequal(1, 1) vld_setequal(1:2, 2:1) vld_setequal(1, 2:1) vld_setequal(1:2, 2)# vld_orderset vld_orderset(1, 1) vld_orderset(1:2, 2:1) vld_orderset(1, 2:1) vld_orderset(1:2, 2) # chk_setequal chk_setequal(1:2, 2:1) try(chk_setequal(1, 1:2)) # vld_setequal vld_setequal(1, 1) vld_setequal(1:2, 2:1) vld_setequal(1, 2:1) vld_setequal(1:2, 2)