R/checkNumber.R

In mllg/checkmate: Fast and Versatile Argument Checks

#' Check if an argument is a single numeric value
#'
#' @templateVar fn Number
#' @template x
#' @template na-handling
#' @template na.ok
#' @template bounds
#' @param finite [\code{logical(1)}]\cr
#'  Check for only finite values? Default is \code{FALSE}.
#' @template null.ok
#' @template checker
#' @useDynLib checkmate c_check_number
#' @family scalars
#' @export
#' @examples
#' testNumber(1)
#' testNumber(1:2)
checkNumber = function(x, na.ok = FALSE, lower = -Inf, upper = Inf, finite = FALSE, null.ok = FALSE) {
  .Call(c_check_number, x, na.ok, lower, upper, finite, null.ok)
}

#' @export
#' @rdname checkNumber
check_number = checkNumber

#' @export
#' @include makeAssertion.R
#' @template assert
#' @rdname checkNumber
assertNumber = makeAssertionFunction(checkNumber, c.fun = "c_check_number", use.namespace = FALSE)

#' @export
#' @rdname checkNumber
assert_number = assertNumber

#' @export
#' @include makeTest.R
#' @rdname checkNumber
testNumber = makeTestFunction(checkNumber, c.fun = "c_check_number")

#' @export
#' @rdname checkNumber
test_number = testNumber

#' @export
#' @include makeExpectation.R
#' @template expect
#' @rdname checkNumber
expect_number = makeExpectationFunction(checkNumber, c.fun = "c_check_number", use.namespace = FALSE)