signal_stage: Signal other experimental or superseded features

In lifecycle: Manage the Life Cycle of your Package Functions

Signal other experimental or superseded features

Description

signal_stage() allows you to signal life cycle stages other than deprecation (for which you should use deprecate_warn() and friends). There is no behaviour associated with this signal, it is currently purely a way to express intent at the call site. In the future, we hope to replace this with a standardized call to base::declare().

Usage

signal_stage(stage, what, with = NULL, env = deprecated())

Arguments

stage	Life cycle stage, either "experimental" or "superseded".
what	String describing what feature the stage applies too, using the same syntax as deprecate_warn().
with	An optional string giving a recommended replacement for a superseded function.
env

Examples

foofy <- function(x, y, z) {
  signal_stage("experimental", "foofy()")
  x + y / z
}
foofy(1, 2, 3)

lifecycle documentation built on Jan. 8, 2026, 9:08 a.m.