R: Check if an argument is a single integerish value

checkInt {checkmate} | R Documentation

## Check if an argument is a single integerish value

### Description

Check if an argument is a single integerish value

### Usage

    checkInt(
      x,
      na.ok = FALSE,
      lower = -Inf,
      upper = Inf,
      tol = sqrt(.Machine$double.eps),
      null.ok = FALSE
    )

    check_int(
      x,
      na.ok = FALSE,
      lower = -Inf,
      upper = Inf,
      tol = sqrt(.Machine$double.eps),
      null.ok = FALSE
    )

    assertInt(
      x,
      na.ok = FALSE,
      lower = -Inf,
      upper = Inf,
      tol = sqrt(.Machine$double.eps),
      null.ok = FALSE,
      coerce = FALSE,
      .var.name = vname(x),
      add = NULL
    )

    assert_int(
      x,
      na.ok = FALSE,
      lower = -Inf,
      upper = Inf,
      tol = sqrt(.Machine$double.eps),
      null.ok = FALSE,
      coerce = FALSE,
      .var.name = vname(x),
      add = NULL
    )

    testInt(
      x,
      na.ok = FALSE,
      lower = -Inf,
      upper = Inf,
      tol = sqrt(.Machine$double.eps),
      null.ok = FALSE
    )

    test_int(
      x,
      na.ok = FALSE,
      lower = -Inf,
      upper = Inf,
      tol = sqrt(.Machine$double.eps),
      null.ok = FALSE
    )

    expect_int(
      x,
      na.ok = FALSE,
      lower = -Inf,
      upper = Inf,
      tol = sqrt(.Machine$double.eps),
      null.ok = FALSE,
      info = NULL,
      label = vname(x)
    )

### Arguments

`x` | [any] Object to check.
`na.ok` | [`logical(1)`] Are missing values allowed? Default is `FALSE`.
`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.
`tol` | [`double(1)`] Numerical tolerance used to check whether a double or complex can be converted. Default is `sqrt(.Machine$double.eps)`.
`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 `assertInt`/`assert_int` return `x` invisibly, whereas `checkInt`/`check_int` and `testInt`/`test_int` return `TRUE`. If the check is not successful, `assertInt`/`assert_int` throws an error message, `testInt`/`test_int` returns `FALSE`, and `checkInt`/`check_int` return a string with the error message. The function `expect_int` always returns an `expectation`.

### Note

To perform an assertion and then convert to integer, use `asInt`. `assertInt` will not convert numerics to integer.

### See Also

Other scalars: `checkCount()`, `checkFlag()`, `checkNumber()`, `checkScalarNA()`, `checkScalar()`, `checkString()`

### Examples

    testInt(1)
    testInt(-1, lower = 0)

[Package checkmate version 2.1.0 Index]