chk_matrix {chk} | R Documentation |
Check Matrix
Description
Checks if is a matrix using
is.matrix(x)
Usage
chk_matrix(x, x_name = NULL)
vld_matrix(x)
Arguments
x |
The object to check. |
x_name |
A string of the name of object x or NULL. |
Value
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.
Functions
-
vld_matrix()
: Validate Matrix
See Also
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()
Examples
# chk_matrix
chk_matrix(matrix(1))
try(chk_matrix(array(1)))
# vld_matrix
vld_matrix(1)
vld_matrix(matrix(1))
[Package chk version 0.9.2 Index]