The R Project SVN R

Rev

Rev 59039 | Rev 75234 | Go to most recent revision | 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
2
% Part of the R package, http://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{
55555 ripley 33
  \code{.Defunct} is called from defunct functions.  Functions should be
29931 ripley 34
  listed in \code{help("pkg-defunct")} for an appropriate \code{pkg},
58117 hornik 35
  including \code{base} (with the alias added to the respective Rd
36
  file).
29931 ripley 37
}
38
\seealso{
39
  \code{\link{Deprecated}}.
5277 maechler 40
 
30681 ripley 41
  \code{base-defunct} and so on which list the defunct functions
29931 ripley 42
  in the packages.
1196 hornik 43
}
1304 maechler 44
\keyword{documentation}
45
\keyword{utilities}