inspect_bfactor checks if an object is a numeric vector of
valid Bayes factor values. This can be useful to validate inputs,
intermediate calculations or outputs in user-defined functions.
inspect_bfactor(x, allow_nas = TRUE, warning_nas = TRUE)| x | An arbitrary object. |
|---|---|
| allow_nas | Logical value. If |
| warning_nas | Logical value. If |
inspect_bfactor does not return any output. There are three
possible outcomes:
The call is silent if:
x is a numeric vector of valid Bayes factor values and there are no
NA or NaN values in x.
x is a numeric vector of valid Bayes factor values, there are some
NA or NaN values in x, allow_nas is set to TRUE and warning_nas
is set to FALSE.
An informative warning message is given if x is a numeric vector of valid
Bayes factor values, there are some NA or NaN values in x and both
allow_nas and warning_nas are set to TRUE.
An informative error message is thrown and the execution is stopped if:
x is not a numeric vector of valid Bayes factor values.
x is a numeric vector of valid Bayes factor values, there are some in
NA or NaN values in x and allow_nas is set to FALSE.
inspect_bfactor conducts a series of tests to check if x is a
numeric vector of valid Bayes factor values. Namely, inspect_bfactor checks
if:
x is NULL or empty.
x is an atomic vector.
x is numeric.
x has NA or NaN values.
The values of x are non-negative.
inspect_bfactor_log to check if an object is a
numeric vector of valid logarithmic Bayes factor values.
bfactor_interpret for the interpretation of Bayes
factors.
inspect_bfactor_scale to check if an object is a
valid Bayes factor interpretation scale.
# Calls that pass silently:
x1 <- c(0, 0.5, 1, 10, 50, 100)
x2 <- c(NA, 0.5, 1, 10, 50, 100)
inspect_bfactor(x1)
inspect_bfactor(x2, warning_nas = FALSE)
inspect_bfactor(x2, allow_nas = TRUE, warning_nas = FALSE)
# Call that throws an informative warning message:
y <- c(0.1, 0.2, NA, 0.4, 0.5)
try(inspect_bfactor(y))
#> Warning: There are NA or NaN values in y.
try(inspect_bfactor(y, warning_nas = TRUE))
#> Warning: There are NA or NaN values in y.
try(inspect_bfactor(y, allow_nas = TRUE, warning_nas = TRUE))
#> Warning: There are NA or NaN values in y.
# Calls that throw informative error messages:
z <- c(-0.9, 0, 0.1, 0.2, 0.3, 0.4, 0.5)
try(inspect_bfactor(z))
#> Error in inspect_bfactor(z) :
#> Invalid argument: all elements of z must be non-negative.
mylist <- list(
NULL, TRUE, factor(.5), matrix(0.5),
"0.5", list(0.5), NA, NaN, numeric(0), -0.5, -5
)
try(inspect_bfactor(mylist[[1]]))
#> Error in inspect_bfactor(mylist[[1]]) :
#> Invalid argument: mylist[[1]] is NULL.
try(inspect_bfactor(mylist[[2]]))
#> Error in inspect_bfactor(mylist[[2]]) :
#> Invalid argument: the type of mylist[[2]] must be numeric.
try(inspect_bfactor(mylist[[3]]))
#> Error in inspect_bfactor(mylist[[3]]) :
#> Invalid argument: mylist[[3]] must be an atomic vector.
try(inspect_bfactor(mylist[[4]]))
#> Error in inspect_bfactor(mylist[[4]]) :
#> Invalid argument: mylist[[4]] must be an atomic vector.
try(inspect_bfactor(mylist[[5]]))
#> Error in inspect_bfactor(mylist[[5]]) :
#> Invalid argument: the type of mylist[[5]] must be numeric.
try(inspect_bfactor(mylist[[6]]))
#> Error in inspect_bfactor(mylist[[6]]) :
#> Invalid argument: mylist[[6]] must be an atomic vector.
try(inspect_bfactor(mylist[[7]]))
#> Error in inspect_bfactor(mylist[[7]]) :
#> Invalid argument: all elements of mylist[[7]] are NA or NaN.
try(inspect_bfactor(mylist[[8]]))
#> Error in inspect_bfactor(mylist[[8]]) :
#> Invalid argument: all elements of mylist[[8]] are NA or NaN.
try(inspect_bfactor(mylist[[9]]))
#> Error in inspect_bfactor(mylist[[9]]) :
#> Invalid argument: mylist[[9]] is empty.
try(inspect_bfactor(mylist[[10]]))
#> Error in inspect_bfactor(mylist[[10]]) :
#> Invalid argument: all elements of mylist[[10]] must be non-negative.
try(inspect_bfactor(mylist[[11]]))
#> Error in inspect_bfactor(mylist[[11]]) :
#> Invalid argument: all elements of mylist[[11]] must be non-negative.