checkmate (version 1.7.3)

checkArray: Check if an argument is an array

Description

Check if an argument is an array

Usage

checkArray(x, mode = NULL, any.missing = TRUE, d = NULL, min.d = NULL,
  max.d = NULL)
assertArray(x, mode = NULL, any.missing = TRUE, d = NULL, min.d = NULL,
  max.d = NULL, add = NULL, .var.name = NULL)
assert_array(x, mode = NULL, any.missing = TRUE, d = NULL, min.d = NULL,
  max.d = NULL, add = NULL, .var.name = NULL)
testArray(x, mode = NULL, any.missing = TRUE, d = NULL, min.d = NULL,
  max.d = NULL)
test_array(x, mode = NULL, any.missing = TRUE, d = NULL, min.d = NULL,
  max.d = NULL)
expect_array(x, mode = NULL, any.missing = TRUE, d = NULL, min.d = NULL,
  max.d = NULL, info = NULL, label = NULL)

Arguments

x

[any] Object to check.

mode

[character(1)] Storage mode of the array. Arrays can hold vectors, i.e. logical, integer, double, numeric, complex, character and li

any.missing

[logical(1)] Are missing values allowed? Default is TRUE.

d

[integer(1)] Exact number of dimensions of array x. Default is NULL (no check).

min.d

[integer(1)] Minimum number of dimensions of array x. Default is NULL (no check).

max.d

[integer(1)] Maximum number of dimensions of array x. Default is NULL (no check).

add

[AssertCollection] Collection to store assertions. See AssertCollection.

.var.name

[NULL || character(1)] Name of the checked object to print in error message. If NULL, the name will be heuristically determined via substitute.

info

[character(1)] Extra information to be included in the message for the testthat reporter. See expect_that.

label

[character(1)] Same as .var.name, but passed down to expect_that.

Value

• Depending on the function prefix: If the check is successful, the functions return TRUE. If the check is not successful, assertArray/assert_array throws an error message, testArray/test_array returns FALSE, and checkArray returns a string with the error message. The function expect_array always returns an expectation.

See Also

Other basetypes: checkAtomicVector, checkAtomic, checkCharacter, checkComplex, checkDataFrame, checkDataTable, checkEnvironment, checkFactor, checkFunction, checkIntegerish, checkInteger, checkList, checkLogical, checkMatrix, checkNumeric, checkVector

Examples

checkArray(array(1:27, dim = c(3, 3, 3)), d = 3)