File: getMarginWidth.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 (36 lines) | stat: -rwxr-xr-x 1,175 bytes parent folder | download | duplicates (8)
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
\name{getMarginWidth}
\alias{getMarginWidth}
\title{Find the margin width necessary to fit text or a legend next to a plot}
\description{
 Calculates the margin width necessary to fit text or a legend next to a plot.
}
\usage{
 getMarginWidth(side=4,labels,is.legend=FALSE)
}
\arguments{
 \item{side}{Which side of the plot (as in axis).}
 \item{labels}{The text to place next to the plot.}
 \item{is.legend}{Whether the text is in a legend or not.}
}
\details{
 \samp{getMarginWidth} reads parameters about the current plot and calculates the
 left or right (default) margin necessary to fit the strings passed as 
 \samp{labels} or a legend containing those strings.
}
\value{
 A two element list containing the number of margin lines necessary to
 fit the text or legend and the horizontal center of the margin in user units.
}
\author{Jim Lemon}
\examples{
 plot(rnorm(10))
 newmarinfo<-getMarginWidth(labels=c("Long label","Even longer label"))
 oldmar<-par("mar")
 par(mar=c(oldmar[1:3],newmarinfo$newmar))
 plot(rnorm(10))
 par(xpd=TRUE)
 text(rep(newmarinfo$marcenter,2),c(0.5,-0.5),
  c("Long label","Even longer label"))
 par(mar=oldmar,xpd=FALSE)
}
\keyword{misc}