validate_arg_function_name: Build hierarchical function names for messages

View source: R/validate_arg_function_name.R

validate_arg_function_nameR Documentation

Build hierarchical function names for messages

Description

Concatenates parent and child function names for a better message, warning, and error tracing.

Usage

validate_arg_function_name(default_name = NULL, function_name = NULL, ...)

Arguments

default_name

(optional, character) Name of the calling function. Default: NULL

function_name

(optional, character) Name of the parent function. Default: NULL

...

(optional) Used to pass function_name within these functions that don't have this argument.

Value

character

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_max_cor(), validate_arg_max_vif(), validate_arg_predictors(), validate_arg_preference_order(), validate_arg_quiet(), validate_arg_responses()

Examples

x <- validate_arg_function_name(
  default_name = "child_function",
  function_name = "parent_function"
)

message(x)

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