R: Marking Objects as Deprecated (original) (raw)
| Deprecated {base} | R Documentation |
|---|
Description
When an object is about to be removed from R it is first deprecated and should include a call to .Deprecated.
Usage
.Deprecated(new, package = NULL, msg,
old = as.character(sys.call(sys.parent()))[1L])
Arguments
| new | character string: A suggestion for a replacement function. |
|---|---|
| package | character string: The package to be used when suggesting where the deprecated function might be listed. |
| msg | character string: A message to be printed, if missing a default message is used. |
| old | character string specifying the function (default) or usage which is being deprecated. |
Details
.Deprecated("new name") is called from deprecated functions. These should be listed in help("pkg-deprecated")for an appropriate pkg, including base. The original help page for a deprecated function is sometimes available at help("old-deprecated") (note the quotes).
.Deprecated signals a warning of class "deprecatedWarning"with fields old, new, and package.
See Also
[Defunct](../../base/help/Defunct.html)
help("[base-deprecated](../../base/help/base-deprecated.html)") and so on which list the deprecated functions in the packages.
[Package _base_ version 4.6.0 Index]