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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot.multcompLetters.R
\name{plot.multcompLetters}
\alias{plot.multcompLetters}
\alias{plot.multcomp}
\title{plot multcomp graphics}
\usage{
\method{plot}{multcompLetters}(
x,
horizontal = FALSE,
col = 1:6,
type = c("Letters", "boxes"),
add = FALSE,
at,
width,
fig = c(0, 1, 0, 1),
label.levels = if (add) NA else 0.05,
label.groups = NA,
...
)
}
\arguments{
\item{x}{an object of class 'multcompTs' or 'multcompLetters'.}
\item{horizontal}{A logical scalar indicating whether the list of items
compared reads left to right (horizontal = TRUE) or top to bottom
(horizontal = FALSE). If this multcomp graphic accompanies boxplots for
different levels or groups compared, the 'boxplot' argument 'horizontal' is
the negation of the multcomp plot 'horizontal' argument.}
\item{col}{The color for each group of items or factor levels. The colors
will cross the different items or factor levels and will therefore have the
orientation specified via 'horizontal'. If the number of columns exceeds
length(col), col is recycled. For alternative choices for col, see "Color
Specification" in the \code{\link{par}} help page.}
\item{type}{An alternative display for either multcompTs or multcompLetters
is 'boxes' (or rectangles). If type="boxes" with "multcompTs", the
"base(s)" of each "T" will be indicated by a triangle.}
\item{add}{TRUE to add to an existing plot; FALSE to start a new plot. The
names of the factor levels or items compared will be plotted only if
add=FALSE.}
\item{at}{A numeric vector or matrix or a list with components "at" and
"width". If a list, both components must be either a numeric vector or
matrix. The numeric vector "at" (whether the function argument or "at"
component of the "at" list) must be either a numeric vector or matrix giving
the locations where the "Ts" or "Letters" graphics should be drawn.
length(at) is 1, 2 or 3 times the number of the number of factor levels or
items compared. If length(at) is twice the number of levels or items
compared, it gives the range of the display for that level; the base of a
"T" will be at the midpoint. If length(at) is three times the number of
items compared, the intermediate number will be the center of the base of
the "T".}
\item{width}{A numeric vector or matrix with as many rows as "Ts" or
"groups" and with up to three columns. With one column, it will be the
"center" of the plot range for that group. With two columns, they will
delimit the range. With three, they will provide "bottom", "center", and
"top" of the range for that set of grouping indicators. If "at" is a list,
the argument "width" is ignored and is taken from the list "at".}
\item{fig}{A numerical vector of the form 'c(x1, x2, y1, y2)' giving the
coordinates of the figure region in the display region of the plot device,
as described on the \code{\link{par}} help page.}
\item{label.levels}{NA for no labels or distance away from the plot for the
labels as a proportion of the plot range.}
\item{label.groups}{NA for no labels or distance away from the plot for the
labels as a proportion of the plot range.}
\item{...}{graphical parameters can be given as described on the
\code{\link{plot}} help page or for plot.multcompLetters as describe on the
\code{\link[grid]{gpar}} help page.}
}
\value{
A list with two components: \item{at }{ A matrix with three columns
giving the middle and extremes of the display for each of the factor levels
or items compared. } \item{width }{ A matrix with as many rows as "Ts" or
comparator levels and with two columns giving the plot range for that
comparator level. }
}
\description{
Plot graphic(s) for multcompTs or multcompLetters objects
}
\details{
The requested graphic is either plotted by itself or added to an existing
plot as specified by the arguments. The placement can be controlled by
'fig' and 'at'.
The fontsize and fontface of a plot of a multcompLetters object with 'type =
"Letters"' can be adjusted as describe on the \code{\link[grid]{gpar}} help
page.
}
\examples{
##
## plot(multcompTs(...))
##
dif4 <- c(.1, .02, .03, 1)
names(dif4) <- c("A-B", "A-C", "B-C", "A-D")
(mcT4 <- multcompTs(dif4))
# Standard plot, base of "Ts" point left
mcT4.1 <- plot(mcT4, label.groups=0.05)
# Redo using "at" = list
plot(mcT4, label.groups=0.05, at=mcT4.1)
# Same plot with group labels closer to the figure
plot(mcT4, label.groups=0.02)
# Base of "Ts" point right
plot(mcT4, label.groups=TRUE, orientation="r")
# Base of "Ts" point down
plot(mcT4, horizontal=TRUE, label.groups=0.05)
# Base of "Ts" point up
plot(mcT4, horizontal=TRUE, label.groups=0.05,
orientation="r")
# Same 4 plots but with boxes & triangles, not Ts
plot(mcT4, label.groups=0.05, type="b")
plot(mcT4, label.groups=0.05, orientation="r",
type="b")
plot(mcT4, horizontal=TRUE, label.groups=0.05,
type="b")
plot(mcT4, horizontal=TRUE, label.groups=0.05,
orientation="r", type="b")
##
## plot(multcompLetters(...))
##
# ... using dif4 from above
(mcL4 <- multcompLetters(dif4, Letters=LETTERS))
# Standard plot
\dontrun{
# Requires (grid)
mcL4.1 <- plot(mcL4, label.groups=0.05)
# Redo using "at" = list
plot(mcL4, label.groups=0.05, at=mcL4.1)
# With bold face and larger font
plot(mcL4, label.groups=0.05,
fontsize=28, fontface="bold")
# Horizontal rather than vertical
plot(mcL4, horizontal=TRUE, label.groups=0.05)
}
# Same as boxes rather than letters
plot(mcL4, label.groups=0.05, type="b")
plot(mcL4, horizontal=TRUE, label.groups=0.05,
type="b")
}
\seealso{
\code{\link{multcompTs}} \code{\link{multcompLetters}}
\code{\link{multcompBoxplot}} \code{\link[grid]{gpar}}
}
\author{
Spencer Graves
}
\keyword{aplot}
|