Check If Two Categories Are Mutually Exclusive

Check if the two input categories are mutually exclusive from each other

Usage

check_if_two_categories_are_mutually_exclusive(
  label_cat_1,
  label_cat_2,
  label_cat_missing = NULL,
  arg_cat_1 = rlang::caller_arg(label_cat_1),
  arg_cat_2 = rlang::caller_arg(label_cat_2),
  arg_cat_missing = rlang::caller_arg(label_cat_missing),
  call = rlang::caller_env()
)

Arguments

label_cat_1

First vector to check for mutually exclusiveness with another vector.

label_cat_2

Second vector to check for mutually exclusiveness with another vector.

label_cat_missing

Missing values vector to check for mutually exclusiveness with another vector if needed. Default: NULL

arg_cat_1

An argument name as a string for the first vector. This argument will be mentioned in error messages as the input that is at the origin of a problem.

arg_cat_2

An argument name as a string for the second vector. This argument will be mentioned in error messages as the input that is at the origin of a problem.

arg_cat_missing

An argument name as a string for the missing values vector. This argument will be mentioned in error messages as the input that is at the origin of a problem.

call

The execution environment of a currently running function, e.g. caller_env(). The function will be mentioned in error messages as the source of the error. See the call argument of abort() for more information.

Value

An error message if the two input categories are not mutually exclusive

See also

caller_arg, stack cli_vec, cli_abort

Examples

# No error
cat_1 <- c("male")
cat_2 <- c("female")
cat_missing <- c("not saying")
check_if_two_categories_are_mutually_exclusive(cat_1, cat_2)
check_if_two_categories_are_mutually_exclusive(cat_1, cat_2, cat_missing)

# Common labels found
cat_1 <- c("male", "female", "not saying")
cat_2 <- c("male", "female", "not saying")
cat_missing <- c("male", "female", "not saying")

try(check_if_two_categories_are_mutually_exclusive(cat_1, cat_2))
#> Error in eval(expr, envir) : 
#>   `cat_1` and `cat_2` must be mutually exclusive.
#> Common values found in `cat_1` and `cat_2`: "male", "female" and "not saying".
#> Please ensure `cat_1` and `cat_2` do not hold common values.

try(check_if_two_categories_are_mutually_exclusive(cat_1, cat_2, cat_missing))
#> Error in eval(expr, envir) : 
#>   `cat_1`, `cat_2` and `cat_missing` must be mutually exclusive.
#> Common values found in `cat_1` and `cat_2`: "male", "female" and "not saying".
#> Common values found in `cat_1` and `cat_missing`: "male", "female" and "not
#> saying".
#> Common values found in `cat_2` and `cat_missing`: "male", "female" and "not
#> saying".
#> Please ensure `cat_1`, `cat_2` and `cat_missing` do not hold common values.