validate_arg_df_not_null: Ensure that argument 'df' is not 'NULL'

In collinear: Automated Multicollinearity Management

Ensure that argument df is not NULL

Description

Internal function to validate the default value of the argument df.

Usage

validate_arg_df_not_null(df = NULL, function_name = NULL)

Arguments

df	(required; dataframe, tibble, or sf) A dataframe with responses (optional) and predictors. Must have at least 10 rows for pairwise correlation analysis, and 10 * (length(predictors) - 1) for VIF. Default: NULL.
function_name	(optional, character string) Name of the function performing the argument check. Default: NULL

Value

dataframe

See Also

Other argument_validation: drop_geometry_column(), validate_arg_df(), validate_arg_encoding_method(), validate_arg_f(), validate_arg_function_name(), validate_arg_max_cor(), validate_arg_max_vif(), validate_arg_predictors(), validate_arg_preference_order(), validate_arg_quiet(), validate_arg_responses()

Examples

data(vi_smol)
df <- validate_arg_df_not_null(
  df = vi_smol
  )

collinear documentation built on Dec. 8, 2025, 5:06 p.m.