inspect_par_haldane: Validate parameters for the Haldane distribution
In inspector: Validation of Arguments and Objects in User-Defined Functions

Description Usage Arguments Details Value See Also Examples

inspect_par_haldane checks if an object is an eligible vector of parameters for the Haldane distribution. This can be useful to validate inputs, intermediate calculations or outputs in user-defined functions.

1	inspect_par_haldane(x)

`x`	An arbitrary object.

inspect_par_haldane conducts a series of tests to check if x is an eligible vector of parameters for the Haldane distribution. Namely, inspect_par_haldane checks if:

x is NULL or empty.
x is an atomic vector
x is numeric
x has NA or NaN values.
All elements of x equal to 0.

inspect_par_haldane does not return any output. There are two possible outcomes:

The call is silent if x is an eligible vector of parameters for the Haldane distribution.
An informative error message is thrown otherwise.

inspect_par_bernoulli to validate parameters for the Bernoulli/Binomial distribution.
inspect_par_multinomial to validate parameters for the Multinomial distribution.
inspect_par_beta to validate parameters for the Beta distribution.
inspect_par_dirichlet to validate parameters for the Dirichlet distribution.

# Calls that pass silently:
x1 <- c(0, 0, 0)
x2 <- c(0, 0)
inspect_par_haldane(x1)
inspect_par_haldane(x2)

# Calls that throw an informative error message:
mylist <- list(
  NULL, factor(0, 0, 0),
  matrix(c(0, 0, 0)), c("0", "0", "0"), list(0, 0, 0), c(0, NA),
  c(0, NaN, 0), c(TRUE, FALSE), numeric(0), c(1, 0, 0)
)
try(inspect_par_haldane(mylist[[1]]))
try(inspect_par_haldane(mylist[[2]]))
try(inspect_par_haldane(mylist[[3]]))
try(inspect_par_haldane(mylist[[4]]))
try(inspect_par_haldane(mylist[[5]]))
try(inspect_par_haldane(mylist[[6]]))
try(inspect_par_haldane(mylist[[7]]))
try(inspect_par_haldane(mylist[[8]]))
try(inspect_par_haldane(mylist[[9]]))
try(inspect_par_haldane(mylist[[10]]))