check_probability: Check if an argument is a single probability value

In Roche/crmPack: Object-Oriented Implementation of CRM Designs

Check if an argument is a single probability value

Description

Check if a given value represents a probability, that is a number within (0, 1) interval, that can optionally be closed at any side.

Usage

check_probability(x, bounds_closed = TRUE)

assert_probability(
  x,
  bounds_closed = TRUE,
  .var.name = checkmate::vname(x),
  add = NULL
)

test_probability(x, bounds_closed = TRUE)

expect_probability(x, bounds_closed = TRUE, info = NULL, label = vname(x))

Arguments

x	(number) a single value to check.
bounds_closed	(logical) should bounds be closed? This can be a scalar or vector of length two. If it is a scalar, then its value applies equally to lower bound 0 and upper bound 1. If this is a vector with two flags, the first flag corresponds to the lower bound 0 only, and the second to the upper bound 1 only.
.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

TRUE if successful, otherwise a string with the error message.

See Also

assertions for more details.

Examples

check_probability(0.5)
check_probability(0, bounds_closed = FALSE)
check_probability(0, bounds_closed = c(FALSE, TRUE))

Roche/crmPack documentation built on April 20, 2024, 1:10 p.m.