The R Project SVN R

Rev

Rev 59039 | Rev 67599 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 59039 Rev 63082
Line 1... Line 1...
1 
% File src/library/stats/man/stats-deprecated.Rd
 1 
% File src/library/stats/man/stats-deprecated.Rd
2 
% Part of the R package, http://www.R-project.org
 2 
% Part of the R package, http://www.R-project.org
3 
% Copyright 1995-2009 R Core Team
 3 
% Copyright 1995-2013 R Core Team
4 
% Distributed under GPL 2 or later
 4 
% Distributed under GPL 2 or later
5 
 
 5 
 
6 
\name{stats-deprecated}
 6 
\name{stats-deprecated}
7 
\alias{stats-deprecated}
 7 
\alias{stats-deprecated}
- 
 
 8 
\alias{plclust}
8 
%------ NOTE:  ../R/stats-deprecated.R   must be synchronized with this!
 9 
%------ NOTE:  ../R/stats-deprecated.R   must be synchronized with this!
9 
\title{Deprecated Functions in Package \pkg{stats}}
 10 
\title{Deprecated Functions in Package \pkg{stats}}
10 
%------ PLEASE: one \alias{.} for EACH ! (+ one \usage{} & \arguments{} for all)
 11 
%------ PLEASE: one \alias{.} for EACH ! (+ one \usage{} & \arguments{} for all)
11 
\description{
 12 
\description{
12 
  These functions are provided for compatibility with older versions of
 13 
  These functions are provided for compatibility with older versions of
13 
  \R only, and may be defunct as soon as the next release.
 14 
  \R only, and may be defunct as soon as the next release.
14 
}
 15 
}
- 
 
 16 
\usage{
- 
 
 17 
plclust(tree, hang = 0.1, unit = FALSE, level = FALSE, hmin = 0,
- 
 
 18 
        square = TRUE, labels = NULL, plot. = TRUE,
- 
 
 19 
        axes = TRUE, frame.plot = FALSE, ann = TRUE,
- 
 
 20 
        main = "", sub = NULL, xlab = NULL, ylab = "Height")
- 
 
 21 
}
- 
 
 22 
\arguments{
- 
 
 23 
  \item{tree}{an object of the type produced by \code{\link{hclust}}.}
- 
 
 24 
 
- 
 
 25 
  \item{hang}{The fraction of the plot height by which labels should hang
- 
 
 26 
    below the rest of the plot.
- 
 
 27 
    A negative value will cause the labels to hang down from 0.}
- 
 
 28 
 
- 
 
 29 
  \item{unit}{logical.  If true, the splits are plotted at
- 
 
 30 
    equally-spaced heights rather than at the height in the object.}
- 
 
 31
- 
 
 32 
  \item{labels}{A character vector of labels for the leaves of the
- 
 
 33 
    tree. By default the row names or row numbers of the original data are
- 
 
 34 
    used. If \code{labels = FALSE} no labels at all are plotted.}
- 
 
 35 
 
- 
 
 36 
  \item{axes, frame.plot, ann}{logical flags as in \code{\link{plot.default}}.}
- 
 
 37
- 
 
 38 
  \item{main, sub, xlab, ylab}{character strings for
- 
 
 39 
    \code{\link{title}}.  \code{sub} and \code{xlab} have a non-NULL
- 
 
 40 
    default when there's a \code{tree$call}.}
- 
 
 41 
  \item{\dots}{Further graphical arguments.  E.g. \code{cex} controls
- 
 
 42 
    the size of the labels (if plotted) in the same way as \code{\link{text}}.}
- 
 
 43 
 
- 
 
 44 
  \item{hmin}{numeric.  All heights less than \code{hmin} are regarded
- 
 
 45 
    as being \code{hmin}: this can be used to suppress detail at the
- 
 
 46 
    bottom of the tree.}
- 
 
 47
- 
 
 48 
  \item{level, square, plot.}{unimplemented arguments for S-PLUS compatibility.}
- 
 
 49 
}
- 
 
 50 
 
15 
\details{
 51 
\details{
16 
  %-- Either:
 52 
  %-- Either:
17 
  There are currently no deprecated functions in this package.
 53 
  %There are currently no deprecated functions in this package.
18 
  %-- Or:
 54 
  %-- Or:
19 
  %% explain *why* it's deprecated, and \code{\link{..}} to new
 55 
  %% explain *why* it's deprecated, and \code{\link{..}} to new
- 
 
 56 
  \code{plcust} is a deprecated wrapper for the \code{plot} method for
- 
 
 57 
  \code{\link{hclust}}, provided long ago for S-PLUS compatibility.
20 
}
 58 
}
21 
\seealso{
 59 
\seealso{
22 
  \code{\link{Deprecated}}
 60 
  \code{\link{Deprecated}}
23 
}
 61 
}
24 
\keyword{misc}
 62 
\keyword{misc}