| 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, https://www.R-project.org
|
2 |
% Part of the R package, https://www.R-project.org
|
| 3 |
% Copyright 1995-2014 R Core Team
|
3 |
% Copyright 1995-2014, 2020 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}
|
- |
|
| 9 |
%------ NOTE: ../R/stats-deprecated.R must be synchronized with this!
|
8 |
%------ NOTE: ../R/stats-deprecated.R must be synchronized with this!
|
| 10 |
\title{Deprecated Functions in Package \pkg{stats}}
|
9 |
\title{Deprecated Functions in Package \pkg{stats}}
|
| 11 |
%------ PLEASE: one \alias{.} for EACH ! (+ one \usage{} & \arguments{} for all)
|
10 |
%------ PLEASE: one \alias{.} for EACH ! (+ one \usage{} & \arguments{} for all)
|
| 12 |
\description{
|
11 |
\description{
|
| 13 |
These functions are provided for compatibility with older versions of
|
12 |
These functions are provided for compatibility with older versions of
|
| 14 |
\R only, and may be defunct as soon as the next release.
|
13 |
\R only, and may be defunct as soon as the next release.
|
| 15 |
}
|
14 |
}
|
| 16 |
\usage{
|
15 |
%% \usage{
|
| 17 |
plclust(tree, hang = 0.1, unit = FALSE, level = FALSE, hmin = 0,
|
16 |
%% plclust(tree, hang = 0.1, unit = FALSE, level = FALSE, hmin = 0,
|
| 18 |
square = TRUE, labels = NULL, plot. = TRUE,
|
17 |
%% square = TRUE, labels = NULL, plot. = TRUE,
|
| 19 |
axes = TRUE, frame.plot = FALSE, ann = TRUE,
|
18 |
%% axes = TRUE, frame.plot = FALSE, ann = TRUE,
|
| 20 |
main = "", sub = NULL, xlab = NULL, ylab = "Height")
|
19 |
%% main = "", sub = NULL, xlab = NULL, ylab = "Height")
|
| 21 |
}
|
20 |
%% }
|
| 22 |
\arguments{
|
21 |
%% \arguments{
|
| 23 |
\item{tree}{an object of the type produced by \code{\link{hclust}}.}
|
22 |
%% \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 |
|
23 |
%%
|
| 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 |
|
24 |
%% .....
|
| 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 |
|
- |
|
| 42 |
\item{hmin}{numeric. All heights less than \code{hmin} are regarded
|
- |
|
| 43 |
as being \code{hmin}: this can be used to suppress detail at the
|
- |
|
| 44 |
bottom of the tree.}
|
- |
|
| 45 |
|
25 |
%% .....
|
| 46 |
\item{level, square, plot.}{unimplemented arguments for S-PLUS compatibility.}
|
- |
|
| 47 |
}
|
26 |
%% }
|
| 48 |
|
- |
|
| 49 |
\details{
|
27 |
\details{
|
| 50 |
%-- Either:
|
28 |
%-- Either:
|
| 51 |
%There are currently no deprecated functions in this package.
|
29 |
There are currently no deprecated functions in this package.
|
| 52 |
%-- Or:
|
30 |
%-- Or:
|
| 53 |
%% explain *why* it's deprecated, and \code{\link{..}} to new
|
31 |
%% explain *why* it's deprecated, and \code{\link{..}} to new
|
| 54 |
\code{plcust} is a deprecated wrapper for the \code{plot} method for
|
32 |
%% \code{plcust} is a deprecated wrapper for the \code{plot} method for
|
| 55 |
\code{\link{hclust}}, provided long ago for S-PLUS compatibility.
|
33 |
%% \code{\link{hclust}}, provided long ago for S-PLUS compatibility.
|
| 56 |
}
|
34 |
}
|
| 57 |
\seealso{
|
35 |
\seealso{
|
| 58 |
\code{\link{Deprecated}}
|
36 |
\code{\link{Deprecated}}
|
| 59 |
}
|
37 |
}
|
| 60 |
\keyword{misc}
|
38 |
\keyword{misc}
|
The R Project SVN
R