Learn R
checkmate (version 1.7.2)

checkMatrix: Check if an argument is a matrix

Description

Check if an argument is a matrix

Usage

checkMatrix(x, mode = NULL, any.missing = TRUE, all.missing = TRUE,
  min.rows = NULL, min.cols = NULL, nrows = NULL, ncols = NULL,
  row.names = NULL, col.names = NULL)
assertMatrix(x, mode = NULL, any.missing = TRUE, all.missing = TRUE,
  min.rows = NULL, min.cols = NULL, nrows = NULL, ncols = NULL,
  row.names = NULL, col.names = NULL, add = NULL, .var.name)
assert_matrix(x, mode = NULL, any.missing = TRUE, all.missing = TRUE,
  min.rows = NULL, min.cols = NULL, nrows = NULL, ncols = NULL,
  row.names = NULL, col.names = NULL, add = NULL, .var.name)
testMatrix(x, mode = NULL, any.missing = TRUE, all.missing = TRUE,
  min.rows = NULL, min.cols = NULL, nrows = NULL, ncols = NULL,
  row.names = NULL, col.names = NULL)
test_matrix(x, mode = NULL, any.missing = TRUE, all.missing = TRUE,
  min.rows = NULL, min.cols = NULL, nrows = NULL, ncols = NULL,
  row.names = NULL, col.names = NULL)
expect_matrix(x, mode = NULL, any.missing = TRUE, all.missing = TRUE,
  min.rows = NULL, min.cols = NULL, nrows = NULL, ncols = NULL,
  row.names = NULL, col.names = 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.
all.missing
[logical(1)] Are matrices with only missing values allowed? Default is TRUE.
min.rows
[integer(1)] Minimum number of rows.
min.cols
[integer(1)] Minimum number of columns.
nrows
[integer(1)] Exact number of rows.
ncols
[integer(1)] Exact number of columns.
row.names
[character(1)] Check for row names. Default is NULL (no check). See checkNamed for possible values. Note that you can use checkSubs
col.names
[character(1)] Check for column names. Default is NULL (no check). See checkNamed for possible values. Note that you can use checkS
add
[AssertCollection] Collection to store assertions. See AssertCollection.
.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, the functions return TRUE. If the check is not successful, assertMatrix/assert_matrix throws an error message, testMatrix/test_matrix returns FALSE, and checkMatrix returns a string with the error message. The function expect_matrix always returns an expectation.

See Also

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

Examples

Run this code
x = matrix(1:9, 3)
colnames(x) = letters[1:3]
testMatrix(x, nrows = 3, min.cols = 1, col.names = "named")

Run the code above in your browser using DataCamp Workspace