1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/signal.R
\name{signal_stage}
\alias{signal_stage}
\title{Signal other experimental or superseded features}
\usage{
signal_stage(stage, what, with = NULL, env = caller_env())
}
\arguments{
\item{stage}{Life cycle stage, either "experimental" or "superseded".}
\item{what}{String describing what feature the stage applies too, using
the same syntax as \code{\link[=deprecate_warn]{deprecate_warn()}}.}
\item{with}{An optional string giving a recommended replacement for
a superseded function.}
\item{env}{Environment used to determine where \code{signal_stage()}
was called, used to determine the package name).}
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
\code{signal_stage()} allows you to signal life cycle stages other than
deprecation (for which you should use \code{\link[=deprecate_warn]{deprecate_warn()}} and friends).
There is no behaviour associated with this signal, but in the future
we will provide tools to log and report on usage of experimental and
superseded functions.
}
\examples{
foofy <- function(x, y, z) {
signal_stage("experimental", "foofy()")
x + y / z
}
foofy(1, 2, 3)
}
|
