The R Project SVN R

Rev

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

Rev 63080 Rev 63082
Line 1... Line 1...
1 
% File src/library/stats/man/hclust.Rd
 1 
% File src/library/stats/man/hclust.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-2007 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 
\newcommand{\CRANpkg}{\href{http://CRAN.R-project.org/package=#1}{\pkg{#1}}}
 6 
\newcommand{\CRANpkg}{\href{http://CRAN.R-project.org/package=#1}{\pkg{#1}}}
7 
 
 7 
 
8 
\name{hclust}
 8 
\name{hclust}
9 
\title{Hierarchical Clustering}
 9 
\title{Hierarchical Clustering}
10 
\alias{hclust}
 10 
\alias{hclust}
11 
\alias{plot.hclust}
 11 
\alias{plot.hclust}
12 
\alias{plclust}
 - 
 
13 
\alias{print.hclust}
 12 
\alias{print.hclust}
14 
\description{
 13 
\description{
15 
  Hierarchical cluster analysis on a set of dissimilarities and
 14 
  Hierarchical cluster analysis on a set of dissimilarities and
16 
  methods for analyzing it.
 15 
  methods for analyzing it.
17 
}
 16 
}
Line 20... Line 19...
20 
 
 19 
 
21 
\method{plot}{hclust}(x, labels = NULL, hang = 0.1,
 20 
\method{plot}{hclust}(x, labels = NULL, hang = 0.1,
22 
     axes = TRUE, frame.plot = FALSE, ann = TRUE,
 21 
     axes = TRUE, frame.plot = FALSE, ann = TRUE,
23 
     main = "Cluster Dendrogram",
 22 
     main = "Cluster Dendrogram",
24 
     sub = NULL, xlab = NULL, ylab = "Height", \dots)
 23 
     sub = NULL, xlab = NULL, ylab = "Height", \dots)
25 
 
 - 
 
26 
plclust(tree, hang = 0.1, unit = FALSE, level = FALSE, hmin = 0,
 - 
 
27 
        square = TRUE, labels = NULL, plot. = TRUE,
 - 
 
28 
        axes = TRUE, frame.plot = FALSE, ann = TRUE,
 - 
 
29 
        main = "", sub = NULL, xlab = NULL, ylab = "Height")
 - 
 
30 
}
 24 
}
31 
\arguments{
 25 
\arguments{
32 
  \item{d}{a dissimilarity structure as produced by \code{dist}.}
 26 
  \item{d}{a dissimilarity structure as produced by \code{dist}.}
33 
 
 27 
 
34 
  \item{method}{the agglomeration method to be used. This should
 28 
  \item{method}{the agglomeration method to be used. This should
Line 38... Line 32...
38 
    \code{"centroid"}.}
 32 
    \code{"centroid"}.}
39 
 
 33 
 
40 
  \item{members}{\code{NULL} or a vector with length size of
 34 
  \item{members}{\code{NULL} or a vector with length size of
41 
    \code{d}. See the \sQuote{Details} section.}
 35 
    \code{d}. See the \sQuote{Details} section.}
42 
 
 36 
 
43 
  \item{x,tree}{an object of the type produced by \code{hclust}.}
 37 
  \item{x}{an object of the type produced by \code{hclust}.}
44 
 
 38 
 
45 
  \item{hang}{The fraction of the plot height by which labels should hang
 39 
  \item{hang}{The fraction of the plot height by which labels should hang
46 
    below the rest of the plot.
 40 
    below the rest of the plot.
47 
    A negative value will cause the labels to hang down from 0.}
 41 
    A negative value will cause the labels to hang down from 0.}
48 
 
 42 
 
Line 55... Line 49...
55 
  \item{main, sub, xlab, ylab}{character strings for
 49 
  \item{main, sub, xlab, ylab}{character strings for
56 
    \code{\link{title}}.  \code{sub} and \code{xlab} have a non-NULL
 50 
    \code{\link{title}}.  \code{sub} and \code{xlab} have a non-NULL
57 
    default when there's a \code{tree$call}.}
 51 
    default when there's a \code{tree$call}.}
58 
  \item{\dots}{Further graphical arguments.  E.g. \code{cex} controls
 52 
  \item{\dots}{Further graphical arguments.  E.g. \code{cex} controls
59 
    the size of the labels (if plotted) in the same way as \code{\link{text}}.}
 53 
    the size of the labels (if plotted) in the same way as \code{\link{text}}.}
60 
 
 - 
 
61 
  \item{unit}{logical.  If true, the splits are plotted at
 - 
 
62 
    equally-spaced heights rather than at the height in the object.}
 - 
 
63 
 
 - 
 
64 
  \item{hmin}{numeric.  All heights less than \code{hmin} are regarded
 - 
 
65 
    as being \code{hmin}: this can be used to suppress detail at the
 - 
 
66 
    bottom of the tree.}
 - 
 
67 
  \item{level, square, plot.}{unimplemented arguments of
 - 
 
68 
    \code{plclust} for S-PLUS compatibility.}
 - 
 
69 
}
 54 
}
70 
\value{
 55 
\value{
71 
  An object of class \bold{hclust} which describes the
 56 
  An object of class \bold{hclust} which describes the
72 
  tree produced by the clustering process.
 57 
  tree produced by the clustering process.
73 
  The object is a list with components:
 58 
  The object is a list with components:
Line 104... Line 89...
104 
    (only returned if the distance object has a \code{"method"}
 89 
    (only returned if the distance object has a \code{"method"}
105 
    attribute).}
 90 
    attribute).}
106 
 
 91 
 
107 
  There are \code{\link{print}}, \code{\link{plot}} and \code{identify}
 92 
  There are \code{\link{print}}, \code{\link{plot}} and \code{identify}
108 
  (see \code{\link{identify.hclust}}) methods and the
 93 
  (see \code{\link{identify.hclust}}) methods and the
109 
  \code{\link{rect.hclust}()} function for \code{hclust} objects.  The
 94 
  \code{\link{rect.hclust}()} function for \code{hclust} objects.
110 
  \code{plclust()} function is basically the same as the \code{plot}
 - 
 
111 
  method, \code{plot.hclust}, primarily for back compatibility with
 - 
 
112 
  S-PLUS.  Its extra arguments are not implemented.
 - 
 
113 
}
 95 
}
114 
\details{
 96 
\details{
115 
  This function performs a hierarchical cluster analysis
 97 
  This function performs a hierarchical cluster analysis
116 
  using a set of dissimilarities for the \eqn{n} objects being
 98 
  using a set of dissimilarities for the \eqn{n} objects being
117 
  clustered.  Initially, each object is assigned to its own
 99 
  clustered.  Initially, each object is assigned to its own