Skip to content

How a function becomes deprecated

Aurélie Siberchicot edited this page Jan 12, 2024 · 5 revisions

A function becomes deprecated in two steps:

In a first step: ⌛

  • the function is still exported (NAMESPACE).
  • its alias is still in its help page.
  • the .Deprecated() function must be called at the begining of the R code of the function.
  • the 'description' field in the function's help page should begin by a sentence like This function is deprecated. See the function \code{xxx} in the package \code{xxx}.

In a second step: 🚮

  • the function is no longer exported; the function is added and commented at the end of the NAMESPACE file in the list of the deprecated functions.
  • the R code of the function is moved in the 'ade4-deprecated.R' file and the R file of the function is removed if necessary.
  • the help file of the function is removed and the alias of this function thus no longer exist in the package.
  • the 'ade4-deprecated.Rd' file is updated; the function removed is added to the list of deprecated functions.

Clone this wiki locally