R: Check that an argument is an atomic vector

checkAtomic {checkmate} | R Documentation

## 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)

    check_atomic(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,
      .var.name = vname(x), add = NULL)

    assert_atomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL,
      min.len = NULL, max.len = NULL, unique = FALSE, names = NULL,
      .var.name = vname(x), add = NULL)

    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 = vname(x))

### 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 `checkSubset` to check for a specific set of names.
`.var.name` | [`character(1)`] Name of the checked object to print in assertions. Defaults to the heuristic implemented in `vname`.
`add` | [`AssertCollection`] Collection to store assertion messages. See `AssertCollection`.
`info` | [character(1)] Extra information to be included in the message for the testthat reporter. See `expect_that`.
`label` | [`character(1)`] Name of the checked object to print in messages. Defaults to the heuristic implemented in `vname`.

### Value

Depending on the function prefix: If the check is successful, the functions `assertAtomic`/`assert_atomic` return `x` invisibly, whereas `checkAtomic`/`check_atomic` and `testAtomic`/`test_atomic` return `TRUE`. If the check is not successful, `assertAtomic`/`assert_atomic` throws an error message, `testAtomic`/`test_atomic` returns `FALSE`, and `checkAtomic` returns a string with the error message. The function `expect_atomic` always returns an `expectation`.

### See Also

Other basetypes: `checkArray`, `checkAtomicVector`, `checkCharacter`, `checkComplex`, `checkDataFrame`, `checkDate`, `checkDouble`, `checkEnvironment`, `checkFactor`, `checkFormula`, `checkFunction`, `checkIntegerish`, `checkInteger`, `checkList`, `checkLogical`, `checkMatrix`, `checkNull`, `checkNumeric`, `checkPOSIXct`, `checkRaw`, `checkVector`

Other atomicvector: `checkAtomicVector`, `checkVector`

### Examples

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

[Package checkmate version 1.9.4 Index]