Check if an argument is a single numeric value

checkNumber(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
finite = FALSE,
null.ok = FALSE
)
check_number(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
finite = FALSE,
null.ok = FALSE
)
assertNumber(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
finite = FALSE,
null.ok = FALSE,
.var.name = vname(x),
add = NULL
)
assert_number(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
finite = FALSE,
null.ok = FALSE,
.var.name = vname(x),
add = NULL
)
testNumber(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
finite = FALSE,
null.ok = FALSE
)
test_number(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
finite = FALSE,
null.ok = FALSE
)
expect_number(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
finite = FALSE,
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. |

finite |
[`logical(1)` ]
Check for only finite values? Default is `FALSE` . |

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` . |

## Value

Depending on the function prefix:
If the check is successful, the functions
`assertNumber`

/`assert_number`

return
`x`

invisibly, whereas
`checkNumber`

/`check_number`

and
`testNumber`

/`test_number`

return
`TRUE`

.
If the check is not successful,
`assertNumber`

/`assert_number`

throws an error message,
`testNumber`

/`test_number`

returns `FALSE`

,
and `checkNumber`

returns a string with the error message.
The function `expect_number`

always returns an
`expectation`

.

## Details

This function does not distinguish between
`NA`

, `NA_integer_`

, `NA_real_`

, `NA_complex_`

`NA_character_`

and `NaN`

.

## See also

## Examples

testNumber(1)

#> [1] TRUE

testNumber(1:2)

#> [1] FALSE