Skip to contents

Creates an active binding that generates a warning when accessed, using warn_deprecated(). The active binding will otherwise be read-only.

Usage

deprecated_binding(what, value)

Arguments

what

(character(1))
A description of the deprecated binding. Should be of the form "Class$field".

value

(any)
The value of the active binding. This should be an expression that will be evaluated in the context of the active binding. It could, for example, refer to self.

Examples

MyClass = R6::R6Class("MyClass", public = list(),
  active = list(
    foo = deprecated_binding("MyClass$foo", "bar")
  )
)
mco = MyClass$new()
mco$foo
#> Warning: 
#>  MyClass$foo is deprecated and will be removed in the future.
#> → Class: Mlr3WarningDeprecated
#> [1] "bar"