checkArray {checkmate}R Documentation

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)

assertArray(x, mode = NULL, any.missing = TRUE, d = NULL, .var.name)

testArray(x, mode = NULL, any.missing = TRUE, d = NULL)

Arguments

x

[ANY]
Object to check.

.var.name

[character(1)]
Name for x. Defaults to a heuristic to determine the name using deparse and substitute.

mode

[character(1)]
Storage mode of the matrix. Matricies can hold “logical”, “integer”, “double”, “numeric”, “complex” and “character”. Default is NULL (no check).

any.missing

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

d

[integer(1)]
Dimensionality of array. Default is NULL (no check).

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 and checkArray returns a string with the error message.

See Also

Other basetypes: assertAtomicVector, checkAtomicVector, testAtomicVector; assertAtomic, checkAtomic, testAtomic; assertCharacter, checkCharacter, testCharacter; assertComplex, checkComplex, testComplex; assertDataFrame, checkDataFrame, testDataFrame; assertEnvironment, checkEnvironment, testEnvironment; assertFactor, checkFactor, testFactor; assertFunction, checkFunction, testFunction; assertIntegerish, checkIntegerish, testIntegerish; assertInteger, checkInteger, testInteger; assertList, checkList, testList; assertLogical, checkLogical, testLogical; assertMatrix, checkMatrix, testMatrix; assertNumeric, checkNumeric, testNumeric; assertVector, checkVector, testVector

Examples

checkArray(array(1:27, dim = c(3, 3, 3)), d = 3)
[Package checkmate version 1.3 Index]