Check and constrain argument max_cor
Arguments
- max_cor
(optional; numeric or NULL) Maximum correlation allowed between pairs of
predictors. Valid values are between 0.01 and 0.99, and recommended values are between 0.5 (strict) and 0.9 (permissive). Default: 0.7- quiet
(optional; logical) If FALSE, messages are printed. Default: FALSE.
- function_name
(optional, character string) Name of the function performing the argument check. Default: NULL
See also
Other argument_validation:
drop_geometry_column(),
validate_arg_df(),
validate_arg_df_not_null(),
validate_arg_encoding_method(),
validate_arg_f(),
validate_arg_function_name(),
validate_arg_max_vif(),
validate_arg_predictors(),
validate_arg_preference_order(),
validate_arg_quiet(),
validate_arg_responses()
Examples
x <- validate_arg_max_cor(
max_cor = 1.5, #wrong value
quiet = FALSE
)
#>
#> collinear::validate_arg_max_cor(): argument 'max_cor' is outside its valid range (>=0.1 to <=1), resetting it to '0.7'.
x
#> [1] 0.7
#> attr(,"validated")
#> [1] TRUE
attributes(x)$validated
#> [1] TRUE