The R Project SVN R

Rev

Rev 75234 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
42333 ripley 1 
% File src/library/base/man/Defunct.Rd
68948 ripley 2 
% Part of the R package, https://www.R-project.org
59039 ripley 3 
% Copyright 1995-2007 R Core Team
42333 ripley 4 
% Distributed under GPL 2 or later
5 
 
1196 hornik 6 
\name{Defunct}
29931 ripley 7 
\title{Marking Objects as Defunct}
56186 murdoch 8 
\alias{Defunct}
1304 maechler 9 
\alias{.Defunct}
59078 murdoch 10 
\alias{defunct}
29931 ripley 11 
 
13905 hornik 12 
\description{
39885 maechler 13 
  When a function is removed from \R it should be replaced by a function
14 
  which calls \code{.Defunct}.
13905 hornik 15 
}
1304 maechler 16 
\usage{
39611 rgentlem 17 
.Defunct(new, package = NULL, msg)
1304 maechler 18 
}
29774 ripley 19 
\arguments{
20 
  \item{new}{
21 
    character string: A suggestion for a replacement function.
22 
  }
23 
  \item{package}{
24 
    character string: The package to be used when suggesting where the
29931 ripley 25 
    defunct function might be listed.
29774 ripley 26 
  }
39611 rgentlem 27 
  \item{msg}{
28 
    character string: A message to be printed, if missing a default
29 
    message is used.
30 
  }
29774 ripley 31 
}
7081 pd 32 
\details{
87271 smeyer 33 
  \code{.Defunct} is called from defunct functions.
34 
  These should be listed in \code{help("\var{pkg}-defunct")}
35 
  for an appropriate \var{pkg}, including \pkg{base}.
36 
  The alias of the defunct function is added to the same file.
75234 luke 37 
 
87271 smeyer 38 
  \code{.Defunct} signals an error of class \code{"defunctError"}
75234 luke 39 
  with fields \code{old}, \code{new}, and \code{package}.
29931 ripley 40 
}
41 
\seealso{
42 
  \code{\link{Deprecated}}.
5277 maechler 43 
 
87271 smeyer 44 
  \code{help("\link{base-defunct}")} and so on which list the defunct
45 
  functions in the packages.
1196 hornik 46 
}
1304 maechler 47 
\keyword{documentation}
48 
\keyword{utilities}