Learn R
checkmate (version 1.7.2)

checkInteger: 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, names = NULL)
assertInteger(x, lower = -Inf, upper = Inf, any.missing = TRUE,
  all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL,
  unique = FALSE, names = NULL, add = NULL, .var.name)
assert_integer(x, lower = -Inf, upper = Inf, any.missing = TRUE,
  all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL,
  unique = FALSE, names = NULL, add = NULL, .var.name)
testInteger(x, lower = -Inf, upper = Inf, any.missing = TRUE,
  all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL,
  unique = FALSE, names = NULL)
test_integer(x, lower = -Inf, upper = Inf, any.missing = TRUE,
  all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL,
  unique = FALSE, names = NULL)
expect_integer(x, lower = -Inf, upper = Inf, any.missing = TRUE,
  all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL,
  unique = FALSE, names = NULL, info = NULL, label = NULL)

Arguments

x
[any] Object to check.
lower
[numeric(1)] Lower value all elements of x must be greater than.
upper
[numeric(1)] Upper value all elements of x must be lower than.
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
add
[AssertCollection] Collection to store assertions. See AssertCollection.
.var.name
[character(1)] Name for x. Defaults to a heuristic to determine the name using deparse and substitute.
info
[character(1)] Extra information to be included in the message for the testthat reporter. See expect_that.
label
[character(1)] Same as .var.name, but passed down to expect_that.

Value

  • Depending on the function prefix: If the check is successful, the functions 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.

Details

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

See Also

asInteger

Other basetypes: checkArray, checkAtomicVector, checkAtomic, checkCharacter, checkComplex, checkDataFrame, checkDataTable, checkEnvironment, checkFactor, checkFunction, checkIntegerish, checkList, checkLogical, checkMatrix, checkNumeric, checkVector

Examples

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

Run the code above in your browser using DataCamp Workspace