R: Check that an argument is an atomic vector

checkAtomicVector {checkmate}

R Documentation

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)

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`.

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 and checkAtomicVector returns a string with the error message.

Other basetypes: assertArray, checkArray, testArray; assertAtomic, checkAtomic, testAtomic; assertCharacter, checkCharacter, testCharacter; assertComplex, checkComplex, testComplex; assertDataFrame, checkDataFrame, testDataFrame; assertEnvironment, checkEnvironment, testEnvironment; assertFactor, checkFactor, testFactor; assertFunction, checkFunction, testFunction; assertIntegerish, checkIntegerish, testIntegerish; assertInteger, checkInteger, testInteger; assertList, checkList, testList; assertLogical, checkLogical, testLogical; assertMatrix, checkMatrix, testMatrix; assertNumeric, checkNumeric, testNumeric; assertVector, checkVector, testVector

Examples

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