validate_df {collinear}R Documentation

Validate Argument df

Description

Internal function to validate the argument df and ensure it complies with the requirements of the package functions. It performs the following actions:

Usage

validate_df(df = NULL, quiet = FALSE)

Arguments

df

(required; data frame, tibble, or sf) A data frame with responses and predictors. Default: NULL.

quiet

(optional; logical) If FALSE, messages generated during the execution of the function are printed to the console Default: FALSE

Value

data frame

See Also

Other data_validation: validate_data_cor(), validate_data_vif(), validate_encoding_arguments(), validate_predictors(), validate_preference_order(), validate_response()

Examples


data(vi)

#validating example data frame
vi <- validate_df(
  df = vi
)

#tagged as validated
attributes(vi)$validated

[Package collinear version 2.0.0 Index]