File: dotchart3.Rd

package info (click to toggle)
hmisc 4.2-0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 3,332 kB
  • sloc: asm: 27,116; fortran: 606; ansic: 411; xml: 160; makefile: 2
file content (204 lines) | stat: -rw-r--r-- 10,962 bytes parent folder | download | duplicates (2)
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
\name{dotchart3}
\alias{dotchart3}
\alias{dotchartp}
\alias{summaryD}
\title{Enhanced Version of dotchart Function}
\description{
These are adaptations of the R dotchart function that sorts categories
top to bottom, adds \code{auxdata} and \code{auxtitle} arguments to put
extra information in the right margin, and for \code{dotchart3} adds
arguments \code{cex.labels}, \code{cex.group.labels}, and
\code{groupfont}.  By default, group headings are in a larger, bold
font.  \code{dotchart3} also cuts a bit of white space from the top and
bottom of the chart.  The most significant change, however, is in how
\code{x} is interpreted.  Columns of \code{x} no longer provide an
alternate way to define groups.  Instead, they define superpositioned
values.  This is useful for showing three quartiles, for example.  Going
along with this change, for \code{dotchart3} \code{pch} can now be a
vector specifying symbols to use going across columns of \code{x}.
\code{x} was changed in this way because to put multiple points on a
line (e.g., quartiles) and keeping track of \code{par()} parameters when
\code{dotchart2} was called with \code{add=TRUE} was cumbersome.
\code{dotchart3} changes the margins to account for horizontal labels.

\code{dotchartp} is a version of \code{dotchart3} for making the chart
with the \code{plotly} package.

\code{summaryD} creates aggregate data using \code{\link{summarize}} and
calls \code{dotchart3} with suitable arguments to summarize data by
major and minor categories.  If \code{options(grType='plotly')} is in
effect and the \code{plotly} package is installed, \code{summaryD} uses
\code{dotchartp} instead of \code{dotchart3}.
}
\usage{
dotchart3(x, labels = NULL, groups = NULL, gdata = NULL,
          cex = par("cex"), pch = 21, gpch = pch, bg = par("bg"),
          color = par("fg"), gcolor = par("fg"), lcolor = "gray",
          xlim = range(c(x, gdata), na.rm=TRUE), main = NULL, xlab = NULL,
          ylab = NULL, auxdata = NULL, auxtitle = NULL, auxgdata=NULL,
          axisat=NULL, axislabels=NULL,
          cex.labels = cex, cex.group.labels = cex.labels * 1.25,
          cex.auxdata=cex, groupfont = 2,
          auxwhere=NULL, height=NULL, width=NULL, \dots)

dotchartp(x, labels = NULL, groups = NULL, gdata = NULL,
            xlim = range(c(x, gdata), na.rm=TRUE), main=NULL,
            xlab = NULL, ylab = '', auxdata=NULL, auxtitle=NULL,
            auxgdata=NULL, auxwhere=c('right', 'hover'),
            symbol='circle', col=colorspace::rainbow_hcl,
            legendgroup=NULL,
            axisat=NULL, axislabels=NULL, sort=TRUE, digits=4, dec=NULL,
            height=NULL, width=700, layoutattr=FALSE, showlegend=TRUE, \dots) 

summaryD(formula, data=NULL, fun=mean, funm=fun,
         groupsummary=TRUE, auxvar=NULL, auxtitle='',
         auxwhere=c('hover', 'right'),
         vals=length(auxvar) > 0, fmtvals=format,
         symbol=if(use.plotly) 'circle' else 21,
         col=if(use.plotly) colorspace::rainbow_hcl else 1:10,
         legendgroup=NULL,
         cex.auxdata=.7, xlab=v[1], ylab=NULL,
         gridevery=NULL, gridcol=gray(.95), sort=TRUE, \dots)
}
\arguments{
  \item{x}{a numeric vector or matrix}
  \item{labels}{labels for categories corresponding to rows of
	\code{x}.  If not specified these are taken from row names of \code{x}.}
  \item{groups,gdata,cex,pch,gpch,bg,color,gcolor,lcolor,xlim,main,xlab,ylab}{see \code{\link{dotchart}}}
  \item{auxdata}{a vector of information to be put in the right margin,
	in the same order as \code{x}.  May be numeric, character, or a
	vector of expressions containing \code{\link{plotmath}} markup.  For
         \code{dotchartp}, \code{auxdata} may be a matrix to go along
         with the numeric x-axis variable, to result in point-specific
         hover text.}
  \item{auxtitle}{a column heading for \code{auxdata}}
  \item{auxgdata}{similar to \code{auxdata} but corresponding to the
		\code{gdata} argument.  These usually represent overall sample sizes
		for each group of lines.}
 \item{axisat}{a vector of tick mark locations to pass to \code{axis}.
	Useful if transforming the data axis}
  \item{axislabels}{a vector of strings specifying axis tick mark
		labels.  Useful if transforming the data axis}
	\item{digits}{number of significant digits for formatting numeric data
    in hover text for \code{dotchartp}}
	\item{dec}{for \code{dotchartp} only, overrides \code{digits} to
         specify the argument to \code{round()} for rounding values for
         hover labels}
  \item{cex.labels}{\code{cex} for labels}
  \item{cex.group.labels}{\code{cex} for group labels}
	\item{cex.auxdata}{\code{cex} for \code{auxdata}}
  \item{groupfont}{font number for group headings}
	\item{auxwhere}{for \code{summaryD} and \code{dotchartp} specifies
         whether \code{auxdata} 
         and \code{auxgdata} are to be placed on the far right of the
         chart, or should appear as pop-up tooltips when hovering the
         mouse over the ordinary \code{x} data points on the chart.
         Ignored for \code{dotchart3}.}
  \item{\dots}{other arguments passed to some of the graphics functions,
    or to \code{dotchart3} or \code{dotchartp} from \code{summaryD}.
         The \code{auxwhere='hover'} option is a useful argument to pass
         from \code{summaryD} to \code{dotchartp}.}
  \item{layoutattr}{set to \code{TRUE} to put \code{plotly::layout}
         information in a list as an attribute \code{layout} of the
         returned \code{plotly} object instead of running the
         \code{plotly} object through the \code{layout} function.  This
         is useful if running \code{dotchartp} multiple times to later
         put together using \code{plotly::subplot} and only then running
         the result through \code{plotly::layout}.}
  \item{showlegend}{set to \code{FALSE} to suppress the \code{plotly}
         legend with \code{dotchartp}}
	\item{formula}{a formula with one variable on the left hand side (the
         variable to compute summary statistics on), and one or two
         variables on the right hand side.  If there are two variables,
         the first is taken as the major grouping variable.  If the left
         hand side variable is a matrix it has to be a legal R variable
         name, not an expression, and \code{fun} needs to be able to
         process a matrix.}
  \item{data}{a data frame or list used to find the variables in
    \code{formula}.  If omitted, the parent environment is used.}
	\item{fun}{a summarization function creating a single number from a
    vector.  Default is the mean.}
	\item{funm}{applies if there are two right hand variables and
         \code{groupsummary=TRUE} and the marginal summaries over just
         the first \code{x} variable need to be computed differently
         than the summaries that are cross-classified by both
         variables.  \code{funm} defaults to \code{fun} and should
         have the same structure as \code{fun}.}
	\item{groupsummary}{By default, when there are two right-hand
         variables, \code{summarize(..., fun)} is called a second time
         without the use of the second variable, to obtain marginal
         summaries for the major grouping variable and display the
         results as a dot (and optionally in the right margin).  Set
         \code{groupsummary=FALSE} to suppress this information.}
  \item{auxvar}{when \code{fun} returns more than one statistic and the
         user names the elements in the returned vector, you can specify
         \code{auxvar} as a single character string naming one of them.
         This will cause the named element to be written in the right
         margin, and that element to be deleted when plotting the statistics.}
	\item{vals}{set to \code{TRUE} to show data values (dot
    locations) in the right margin.  Defaults to \code{TRUE} if
         \code{auxvar} is specified.}
	\item{fmtvals}{an optional function to format values before putting
         them in the right margin.  Default is the \code{format}
         function.}
  \item{symbol}{a scalar or vector of \code{pch} values for ordinary
         graphics or a character vector or scalar of \code{plotly}
         symbols.   These correspond to columns of \code{x} or elements
         produced by \code{fun}.}
  \item{col}{a function or vector of colors to assign to multiple points
         plotted in one line. If a function it will be evaluated with an
         argument equal to the number of groups/columns.}
  \item{legendgroup}{see \code{plotly} documentation; corresponds to
         column names/\code{fun} output for \code{plotly} graphs only}
 	\item{gridevery}{specify a positive number to draw very faint vertical
    grid lines every \code{gridevery} \code{x}-axis units; for
    non-\code{plotly} charts}
	\item{gridcol}{color for grid lines; default is very faint gray scale}
	\item{sort}{specify \code{sort=FALSE} to plot data in the original
         order, from top to bottom on the dot chart.  For
         \code{dotchartp}, set \code{sort} to \code{'descending'} to
         sort in descending order of the first column of \code{x}, or
         \code{'ascending'} to do the reverse.  These do not make sense
         if \code{groups} is present.}
	\item{height,width}{height and width in pixels for \code{dotchartp} if
         not using \code{plotly} defaults.  Ignored for
         \code{dotchart3}.  If set to \code{"auto"} the height is
         computed using \code{Hmisc::plotlyHeightDotchart}.}
}
\value{the function returns invisibly}
\author{Frank Harrell}
\seealso{\code{\link{dotchart}},\code{\link{dotchart2}},\code{\link{summarize}},
         \code{\link{rlegend}}}
\examples{
set.seed(135)
maj <- factor(c(rep('North',13),rep('South',13)))
g <- paste('Category',rep(letters[1:13],2))
n <- sample(1:15000, 26, replace=TRUE)
y1 <- runif(26)
y2 <- pmax(0, y1 - runif(26, 0, .1))
dotchart3(cbind(y1,y2), g, groups=maj, auxdata=n, auxtitle='n',
          xlab='Y', pch=c(1,17))
## Compare with dotchart function (no superpositioning or auxdata allowed):
## dotchart(y1, g, groups=maj, xlab='Y')

\dontrun{
dotchartp(cbind(y1, y2), g, groups=maj, auxdata=n, auxtitle='n',
          xlab='Y', gdata=cbind(c(0,.1), c(.23,.44)), auxgdata=c(-1,-2),
          symbol=c('circle', 'line-ns-open'))
}

## Put options(grType='plotly') to have the following use dotchartp
## (rlegend will not apply)
## Add argument auxwhere='hover' to summaryD or dotchartp to put
## aux info in hover text instead of right margin
summaryD(y1 ~ maj + g, xlab='Mean')
summaryD(y1 ~ maj + g, groupsummary=FALSE)
summaryD(y1 ~ g, fmtvals=function(x) sprintf('\%4.2f', x))
Y <- cbind(y1, y2)   # summaryD cannot handle cbind(...) ~ ...
summaryD(Y  ~ maj + g, fun=function(y) y[1,], symbol=c(1,17))
rlegend(.1, 26, c('y1','y2'), pch=c(1,17))

summaryD(y1 ~ maj, fun=function(y) c(Mean=mean(y), n=length(y)),
         auxvar='n', auxtitle='N')
}
\keyword{hplot}