checkmate (version 1.6.1)

checkAtomicVector: Check that an argument is an atomic vector

Description

An atomic vector is defined slightly different from specifications in is.atomic and is.vector: An atomic vector is either logical, integer, numeric, complex, character or raw and can have any attributes. I.e., a factor is an atomic vector, but NULL is not. In short, this is equivalent to is.atomic(x) && !is.null(x).

Usage

checkAtomicVector(x, any.missing = TRUE, all.missing = TRUE, len = NULL,
  min.len = NULL, max.len = NULL, unique = FALSE, names = NULL)
assertAtomicVector(x, any.missing = TRUE, all.missing = TRUE, len = NULL,
  min.len = NULL, max.len = NULL, unique = FALSE, names = NULL,
  .var.name)
testAtomicVector(x, any.missing = TRUE, all.missing = TRUE, len = NULL,
  min.len = NULL, max.len = NULL, unique = FALSE, names = NULL)
expect_atomic_vector(x, 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.

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.

.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, assertAtomicVector throws an error message, testAtomicVector returns FALSE, checkAtomicVector returns a string with the error message. The function expect_atomic_vector will return an expectation.

See Also

Other atomicvector: assertAtomic, checkAtomic, expect_atomic, testAtomic; assertVector, checkVector, expect_vector, testVector

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

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