File: dendroPlot.Rd

package info (click to toggle)
r-cran-plotrix 3.2-6-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 1,136 kB
  • sloc: makefile: 3
file content (65 lines) | stat: -rw-r--r-- 3,098 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
\name{dendroPlot}
\alias{dendroPlot}
\title{ Display distributions as dendrites }
\description{
 Display the distributions of one or more sets of points as branching
  (dendritic) clusters.
}
\usage{
 dendroPlot(x,breaks=list(10,10,10),pch=1,col=par("fg"),cex=1,nudge=NA,
  setlabels=NA,...)
}
\arguments{
 \item{x}{A list or data frame of numeric or factor or character
  columns.}
 \item{breaks}{A list of cutpoints to transform numeric values into factors
  (see \link{cut}). Must be at least one number >= 2.}
 \item{pch}{Symbol(s) to use in plotting the values.}
 \item{col}{Color(s) for the symbols.}
 \item{cex}{Size of the symbol(s) to use in plotting.}
 \item{nudge}{The amount to set each consecutive value in a category away from
  the center of the dendrite.}
 \item{setlabels}{Labels to place along the abcissa to identify the sets.}
 \item{...}{Other arguments passed to plot.}
}
\details{
 \samp{dendroPlot} displays the distributions of categorical values as stacks
 of "branches". The lengths of the branches show the number of values in each
 category, rather like the opposed bars in a pyramid plot, except that there
 is no separation of groups. The distribution of numeric values can also be
 displayed by passing a set of breakpoints to categorize the values. The
 breakpoints will usually be equidistant, but unevenly spaced breakpoints can
 be passed. If an element of \samp{x} is numeric, the values of the
 corresponding \samp{x} element will be used to place the points, but the
 branches will be defined as the categories formed by applying the breaks to
 those numeric values.

 Note that in the first example, the breakpoints for the first and third elements
 are used to define the ten branches for each. The second element of \samp{x}
 is already categorical, so the breakpoints are ignored. When comparing 
 distributions with very different ranges it may be necessary to adjust the
 breakpoints to get a satisfactory result.

 Each successive point in a category is \samp{nudge}d away from the center
 of the dendrite. If \samp{nudge} has more than one value, the points will be
 nudged up and down for categorical variables to enable closer packing. The
 second value of \samp{nudge} is ignored for numeric variables. The aspect
 ratio of the plot, the character expansion and the nudging will have to be
 adjusted to give the best point spacing for most dendroPlots.
}
\note{The \samp{ehplot} function is a much more versatile instantiation of this
 type of plot. \samp{dendroPlot} has been retained as there are currently a few
 differences that some users may find valuable. However, it is not impossible
 that \samp{dendroPlot} will disappear in the future.
}
\value{nil}
\author{Jim Lemon}
\seealso{\link{ehplot}}
\examples{
 x<-list(runif(90,1,3),factor(sample(LETTERS[1:10],100,TRUE)),rnorm(80,mean=5))
 dendroPlot(x,xlab="Groups",ylab="Value of x",main="Test dendroPlot I")
 # now apply a nudge factor and different breaks
 dendroPlot(x,breaks=list(8,10,10),nudge=c(0.05,0.1),
  xlab="Groups",ylab="Value of x",main="Test dendroPlot II")
}
\keyword{misc}