checkmate (version 1.6.2)

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, .var.name)
testArray(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 dimensionality of array x. Default is NULL (no check).

min.d

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

max.d

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

.var.name

[character(1)] Name for x. Defaults to a heuristic to determine the name using deparse and 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, all functions return TRUE. If the check is not successful, assertArray throws an error message, testArray returns FALSE, checkArray returns a string with the error message. The function expect_array will return an expectation.

See Also

Other basetypes: assertAtomicVector, checkAtomicVector, expect_atomic_vector, testAtomicVector; assertAtomic, checkAtomic, expect_atomic, testAtomic; assertCharacter, checkCharacter, expect_character, testCharacter; assertComplex, checkComplex, expect_complex, testComplex; assertDataFrame, checkDataFrame, expect_data_frame, testDataFrame; assertEnvironment, checkEnvironment, expect_environment, testEnvironment; assertFactor, checkFactor, expect_factor, testFactor; assertFunction, checkFunction, expect_function, testFunction; assertIntegerish, checkIntegerish, expect_integerish, testIntegerish; assertInteger, checkInteger, expect_integer, testInteger; assertList, checkList, expect_list, testList; assertLogical, checkLogical, expect_logical, testLogical; assertMatrix, checkMatrix, expect_matrix, testMatrix; assertNumeric, checkNumeric, expect_numeric, testNumeric; assertVector, checkVector, expect_vector, testVector

Examples

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