R: Check if an object is an integerish vector

checkIntegerish {checkmate} | R Documentation

## Check if an object is an integerish vector

### Description

An integerish value is defined as value safely convertible to integer. This includes integers and numeric values which are close to an integer w.r.t. a numeric tolerance.

### Usage

    checkIntegerish(
      x,
      tol = sqrt(.Machine$double.eps),
      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_integerish(
      x,
      tol = sqrt(.Machine$double.eps),
      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
    )

    assertIntegerish(
      x,
      tol = sqrt(.Machine$double.eps),
      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,
      coerce = FALSE,
      .var.name = vname(x),
      add = NULL
    )

    assert_integerish(
      x,
      tol = sqrt(.Machine$double.eps),
      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,
      coerce = FALSE,
      .var.name = vname(x),
      add = NULL
    )

    testIntegerish(
      x,
      tol = sqrt(.Machine$double.eps),
      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_integerish(
      x,
      tol = sqrt(.Machine$double.eps),
      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_integerish(
      x,
      tol = sqrt(.Machine$double.eps),
      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.
`tol` | [`double(1)`] Numerical tolerance used to check whether a double or complex can be converted. Default is `sqrt(.Machine$double.eps)`.
`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.
`coerce` | [`logical(1)`] If `TRUE`, the input `x` is returned as integer after an successful assertion.
`.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 `assertIntegerish`/`assert_integerish` return `x` invisibly, whereas `checkIntegerish`/`check_integerish` and `testIntegerish`/`test_integerish` return `TRUE`. If the check is not successful, `assertIntegerish`/`assert_integerish` throws an error message, `testIntegerish`/`test_integerish` returns `FALSE`, and `checkIntegerish` returns a string with the error message. The function `expect_integerish` always returns an `expectation`.

### Note

To convert from integerish to integer, use `asInteger`.

### See Also

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

### Examples

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

[Package checkmate version 2.0.0 Index]