Validate Binary Response

Source: R/utils_validation.R

Ensures that the response vector conforms to the required binary labels.

ensure_binary_response(y, positive = NULL, negative = NULL)

Arguments

y

Vector containing two outcome levels. Accepted types include factor, character, logical, or numeric. Level names are coerced to the canonical c("No", "Yes") order.

positive

Optional character vector of value(s) to treat as the positive ("Yes") class. Comparisons are case-insensitive.

negative

Optional character vector of value(s) to treat as the negative ("No") class. Comparisons are case-insensitive.

Value

Factor with levels c("No", "Yes").

Examples

ensure_binary_response(c("control", "fgr", "control"))
#> [1] No  Yes No 
#> Levels: No Yes
ensure_binary_response(factor(c("case", "control")), positive = "case")
#> [1] Yes No 
#> Levels: No Yes