R: Check if an argument is vector of type integer

checkInteger {checkmate} | R Documentation

## Check if an argument is vector of type integer

### Description

Check if an argument is vector of type integer

### Usage

    checkInteger(x, lower = -Inf, upper = Inf, any.missing = TRUE,
      all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL,
      unique = FALSE, sorted = FALSE, names = NULL, null.ok = FALSE)

    check_integer(x, lower = -Inf, upper = Inf, any.missing = TRUE,
      all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL,
      unique = FALSE, sorted = FALSE, names = NULL, null.ok = FALSE)

    assertInteger(x, lower = -Inf, upper = Inf, any.missing = TRUE,
      all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL,
      unique = FALSE, sorted = FALSE, names = NULL, null.ok = FALSE,
      .var.name = vname(x), add = NULL)

    assert_integer(x, lower = -Inf, upper = Inf, any.missing = TRUE,
      all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL,
      unique = FALSE, sorted = FALSE, names = NULL, null.ok = FALSE,
      .var.name = vname(x), add = NULL)

    testInteger(x, lower = -Inf, upper = Inf, any.missing = TRUE,
      all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL,
      unique = FALSE, sorted = FALSE, names = NULL, null.ok = FALSE)

    test_integer(x, lower = -Inf, upper = Inf, any.missing = TRUE,
      all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL,
      unique = FALSE, sorted = FALSE, names = NULL, null.ok = FALSE)

    expect_integer(x, lower = -Inf, upper = Inf, any.missing = TRUE,
      all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL,
      unique = FALSE, sorted = FALSE, names = NULL, null.ok = FALSE,
      info = NULL, label = vname(x))

### Arguments

`x` | [any] Object to check.
`lower` | [`numeric(1)`] Lower value all elements of `x` must be greater than or equal to.
`upper` | [`numeric(1)`] Upper value all elements of `x` must be lower than or equal to.
`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`.
`sorted` | [`logical(1)`] Elements must be sorted in ascending order. Missing values are ignored.
`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.
`null.ok` | [`logical(1)`] If set to `TRUE`, `x` may also be `NULL`. In this case only a type check of `x` is performed, all additional checks are disabled.
`.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`.

### Details

This function does not distinguish between `NA`, `NA_integer_`, `NA_real_`, `NA_complex_` `NA_character_` and `NaN`.

### Value

Depending on the function prefix: If the check is successful, the functions `assertInteger`/`assert_integer` return `x` invisibly, whereas `checkInteger`/`check_integer` and `testInteger`/`test_integer` return `TRUE`. If the check is not successful, `assertInteger`/`assert_integer` throws an error message, `testInteger`/`test_integer` returns `FALSE`, and `checkInteger` returns a string with the error message. The function `expect_integer` always returns an `expectation`.

### See Also

`asInteger`

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

### Examples

    testInteger(1L)
    testInteger(1.)
    testInteger(1:2, lower = 1, upper = 2, any.missing = FALSE)

[Package checkmate version 1.9.4 Index]