Skip to contents

Create a validated reactive factor-like character vector

Source: R/vrv_fct.R
vrv_fct.Rd

A wrapper around validated_reactive_val() to help manage factor-like values, especially in a cascading / dependent manner. This is a convenience function that constructs the validation_expr for you by wrapping stbl::stabilize_fct(). Note that the objects returned by the resulting vrv are character vectors, not factors, to allow values to remain unchanged when the allowed levels change but the value is still valid.

Usage

vrv_fct(
  levels,
  value = NULL,
  default = NULL,
  allow_null = TRUE,
  allow_na = TRUE,
  min_size = NULL,
  max_size = NULL,
  to_na = character(),
  label = NULL,
  env = rlang::caller_env()
)

vrv_fct_scalar(
  levels,
  value = NULL,
  default = NULL,
  allow_null = TRUE,
  allow_zero_length = TRUE,
  allow_na = TRUE,
  to_na = character(),
  label = NULL,
  env = rlang::caller_env()
)

Arguments

levels

(expression) An expression that returns a character vector of valid levels. Can be a reactive expression.

value

(various) The initial value. This value will be coerced via the validation expression when accessed. If this value is reactive, an observer with priority = Inf will be created to attempt to keep the validated value in sync with that reactive.

default

(various, including expression or reactive expression) A value to use when the current value is not valid according to the defined rules. Defaults to NULL.

allow_null

(length-1 logical, expression, or reactive expression) Is NULL an acceptable value?

allow_na

(length-1 logical, expression, or reactive expression) Are NA values okay?

min_size

(length-1 integer, expression, or reactive expression) The minimum size of the vector.

max_size

(length-1 integer, expression, or reactive expression) The maximum size of the vector.

to_na

(expression) Values to coerce to NA. Can be a reactive expression.

label

(length-1 character or NULL) An optional label for the validated_reactive_value, used for debugging.

env

(environment) The environment in which to evaluate the validation_expr.

allow_zero_length

(expression) Is a zero-length vector acceptable? Can be a reactive expression.

Value

A vrv object which returns a factor-like character vector.