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
|
\name{plotCI}
\alias{plotCI}
\title{Plot confidence intervals/error bars}
\description{
Given a set of x and y values and upper and lower bounds,
this function plots the points with error bars.
}
\usage{
plotCI(x,y=NULL,uiw,liw=uiw,ui=NULL,li=NULL,err="y",
sfrac=0.01,gap=0,slty=par("lty"),add=FALSE,scol=NULL,pt.bg=par("bg"),...)
}
\arguments{
\item{x}{The x coordinates of points in the plot}
\item{y}{The y coordinates of points in the plot}
\item{uiw}{The width of the upper portion of the confidence region,
or (if \samp{liw} is missing) the width of both halves of
the confidence region}
\item{liw}{The width of the lower portion of the confidence region (if
missing, the function assumes symmetric confidence bounds)}
\item{ui}{The absolute upper limit of the confidence region}
\item{li}{The absolute lower limit of the confidence region}
\item{err}{The direction of error bars: "x" for horizontal, "y"
for vertical ("xy" would be nice but is not implemented yet; don't
know quite how everything would be specified. See examples for
composing a plot with simultaneous horizontal and vertical error bars)}
\item{gap}{Size of gap in error bars around points
(default 0;gap=TRUE gives gap size of 0.01)}
\item{sfrac}{Scaling factor for the size of the "serifs" (end bars) on
the confidence bars, in x-axis units}
\item{add}{If FALSE (default), create a new plot; if TRUE, add error
bars to an existing plot.}
\item{slty}{Line type of error bars}
\item{scol}{Color of error bars: if \samp{col} is specified in the
optional arguments, \samp{scol} is set the same; otherwise it's set
to \samp{par(col)}}
\item{pt.bg}{Background color of points (use pch=21, pt.bg=par("bg")
to get open points superimposed on error bars)}
\item{\dots}{Any other parameters to be passed through to
\link{plot.default}, \link{points},
\link{arrows}, etc. (e.g. \samp{lwd}, \samp{col}, \samp{pch},
\samp{axes}, \samp{xlim}, \samp{ylim}). \samp{xlim} and
\samp{ylim} are set by default to include all of the data points and
error bars. \samp{xlab} and \samp{ylab} are set to the names of
\samp{x} and \samp{y}. If \samp{pch==NA}, no points are drawn
(e.g. leaving room for text labels instead)}
}
\value{
invisible(x,y); creates a plot on the current device.
}
\author{Ben Bolker (documentation and tweaking of a function provided by
Bill Venables, additional feature ideas from Gregory Warnes)}
\seealso{\link{boxplot}}
\examples{
y<-runif(10)
err<-runif(10)
plotCI(1:10,y,err,main="Basic plotCI")
plotCI(1:10,y,err,2*err,lwd=2,col="red",scol="blue",
main="Add colors to the points and error bars")
err.x<-runif(10)
err.y<-runif(10)
plotCI(1:10,y,err.y,pt.bg=par("bg"),pch=21,xlim=c(0,11),
main="plotCI with extra space on the x axis")
plotCI(1:10,y,err.x,pt.bg=par("bg"),pch=21,err="x",add=TRUE)
mtext("for adding horizontal error bars",3,0.5)
data(warpbreaks)
attach(warpbreaks)
wmeans<-by(breaks,tension,mean)
wsd<-by(breaks,tension,sd)
## note that barplot() returns the midpoints of the bars, which plotCI
## uses as x-coordinates
plotCI(barplot(wmeans,col="gray",ylim=c(0,max(wmeans+wsd))),wmeans,wsd,add=TRUE)
## using labels instead of points
labs<-sample(LETTERS,replace=TRUE,size=10)
plotCI(1:10,y,err,pch=NA,gap=0.02,main="plotCI with labels at points")
text(1:10,y,labs)
}
\keyword{hplot}
|