Learn R
checkmate (version 1.7.2)

checkAtomic: Check that an argument is an atomic vector

Description

For the definition of atomic, see is.atomic.

Usage

checkAtomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL,
  min.len = NULL, max.len = NULL, unique = FALSE, names = NULL)
assertAtomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL,
  min.len = NULL, max.len = NULL, unique = FALSE, names = NULL,
  add = NULL, .var.name)
assert_atomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL,
  min.len = NULL, max.len = NULL, unique = FALSE, names = NULL,
  add = NULL, .var.name)
testAtomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL,
  min.len = NULL, max.len = NULL, unique = FALSE, names = NULL)
test_atomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL,
  min.len = NULL, max.len = NULL, unique = FALSE, names = NULL)
expect_atomic(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. Note that you can use
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, assertAtmoic/assert_atmoic throws an error message, testAtmoic/test_atmoic returns FALSE, and checkAtmoic returns a string with the error message. The function expect_atmoic always returns an expectation.

See Also

Other atomicvector: checkAtomicVector, checkVector

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

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

Examples

Run this code
testAtomic(letters, min.len = 1L, any.missing = FALSE)

Run the code above in your browser using DataCamp Workspace