checkr (version 0.5.0)

check_prob: Check Probability

Description

Checks if x is a probability (non-missing dbl between 0 and 1 inclusive with no attributes including names).

Usage

check_prob(x, coerce = FALSE, x_name = substitute(x), error = TRUE)
check_probability(x, coerce = FALSE, x_name = substitute(x),
  error = TRUE)
check_prop(x, coerce = FALSE, x_name = substitute(x), error = TRUE)

Arguments

x

The object to check.

coerce

A flag indicating whether to coerce an integer to a dbl and drop attributes including names.

x_name

A string of the name of the object.

error

A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.

Value

An invisible copy of x (if it doesn't throw an error).

See Also

check_scalar

Examples

# NOT RUN {
check_prob(1, error = FALSE)
check_prob(1.1, error = FALSE)
check_prob(c(0, 1), error = FALSE)
# }