R/supporting_functions.R
check_inputs.RdChecks whether a data frame contains all the required variables. Matching works via variable names, and used to support individual functions in the package. Not used directly.
check_inputs(input, requirements, return = "stop")Pass a data frame for checking
A character vector specifying the required variable names
A character string specifying what to return. The default value is "stop". Also accepts "names" and "warning".
The default behaviour is to return an error message, informing the
user what variables are not included. When return is set to "names", a
character vector containing the unmatched variable names is returned.
Other Support:
camel_clean(),
combine_signals(),
cut_hour(),
extract_date_range(),
extract_hr(),
heat_colours(),
is_date_format(),
maxmin(),
p_test(),
pairwise_count(),
plot_WOE(),
read_preamble(),
rgb2hex(),
totals_bind(),
totals_col(),
totals_reorder(),
tstamp(),
us_to_space(),
wrap()
# Return error message
if (FALSE) {
check_inputs(iris, c("Sepal.Length", "mpg"))
}
#' # Return warning message
check_inputs(iris, c("Sepal.Length", "mpg"), return = "warning")
#> Warning: The following variables are not included in the input data frame:
#> mpg
# Return variable names
check_inputs(iris, c("Sepal.Length", "Sepal.Width", "RandomVariable"), return = "names")
#> [1] "RandomVariable"