checkmate (version 1.6.2)

checkVector: Check if an argument is a vector

Description

Check if an argument is a vector

Usage

checkVector(x, strict = FALSE, any.missing = TRUE, all.missing = TRUE,
  len = NULL, min.len = NULL, max.len = NULL, unique = FALSE,
  names = NULL)
assertVector(x, strict = FALSE, any.missing = TRUE, all.missing = TRUE,
  len = NULL, min.len = NULL, max.len = NULL, unique = FALSE,
  names = NULL, .var.name)
testVector(x, strict = FALSE, any.missing = TRUE, all.missing = TRUE,
  len = NULL, min.len = NULL, max.len = NULL, unique = FALSE,
  names = NULL)
expect_vector(x, strict = FALSE, any.missing = TRUE, all.missing = TRUE,
  len = NULL, min.len = NULL, max.len = NULL, unique = FALSE,
  names = NULL, info = NULL, label = NULL)

Arguments

x

[any] Object to check.

strict

[logical(1)] May the vector have additional attributes or perform a check for additional attributes like is.vector? Default is FALSE which allows e.g. factors or

any.missing

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

all.missing

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

len

[integer(1)] Exact expected length of x.

min.len

[integer(1)] Minimal length of x.

max.len

[integer(1)] Maximal length of x.

unique

[logical(1)] Must all values be unique? Default is FALSE.

names

[character(1)] Check for names. See checkNamed for possible values. Default is any which performs no check at all. Note that you can use

.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, assertVector throws an error message, testVector returns FALSE, checkVector returns a string with the error message. The function expect_vector will return an expectation.

See Also

Other atomicvector: assertAtomicVector, checkAtomicVector, expect_atomic_vector, testAtomicVector; assertAtomic, checkAtomic, expect_atomic, testAtomic

Other basetypes: assertArray, checkArray, expect_array, testArray; 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

Examples

testVector(letters, min.len = 1L, any.missing = FALSE)