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
|
\name{axis.mult}
\alias{axis.mult}
\title{ Display an axis with values having a multiplier }
\description{
An axis is displayed on an existing plot where the tick values are divided
by a multiplier and the multiplier is displayed next to the axis.
}
\usage{
axis.mult(side=1,at=NULL,labels,mult=1,mult.label,mult.line,
mult.labelpos=NULL,...)
}
\arguments{
\item{side}{which side to display}
\item{at}{where to place the tick marks - defaults to \samp{axTicks()}}
\item{labels}{tick labels - defaults to at/mult}
\item{mult}{the multiplier factor}
\item{mult.label}{the label to show the multiplier - defaults to "x mult"}
\item{mult.line}{the margin line upon which to show the multiplier}
\item{mult.labelpos}{where to place \samp{mult.label} - defaults to centered
and outside the axis tick labels}
\item{...}{additional arguments passed to \samp{axis}.}
}
\value{nil}
\details{
\samp{axis.mult} automates the process of displaying an axis with a
multiplier applied to the tick values. By default it will divide the
default axis tick labels by \samp{mult} and place \samp{mult.label}
where \samp{xlab} or \samp{ylab} would normally appear. Thus the plot
call should set the relevant label to an empty string in such cases.
It is simplest to call \samp{plot} with \samp{axes=FALSE} and then
display the box and any standard axes before calling \samp{axis.mult}.
}
\note{
While \samp{axis.mult} will try to display an axis on any side, the top
and right margins will require adjustment using \samp{par} for
\samp{axis.mult} to display properly.
}
\author{Jim Lemon}
\seealso{\link{axis}, \link{mtext}}
\examples{
plot(1:10*0.001,1:10*100,axes=FALSE,xlab="",ylab="",main="Axis multipliers")
box()
axis.mult(1,mult=0.001)
axis.mult(2,mult=100)
}
\keyword{misc}
|