File: tab.title.Rd

package info (click to toggle)
r-cran-plotrix 2.9-3-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 960 kB
  • sloc: makefile: 3
file content (42 lines) | stat: -rw-r--r-- 1,348 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
37
38
39
40
41
42
\name{tab.title}
\alias{tab.title}
\title{
 Display the title of a plot as a colored tab
}
\description{
 Display the title of a plot as a colored tab.
}
\usage{
 tab.title(label,text.col=par("fg"),tab.col=par("bg"),border=par("fg"),
  lwd=par("lwd"),cex=1.5,pad.mult=1.6,radius=0)
}
\arguments{
 \item{label}{The title for the plot.}
 \item{text.col}{The color for the title text.}
 \item{tab.col}{The color for the tab fill.}
 \item{border}{The color for the tab border.}
 \item{lwd}{The line width for the border.}
 \item{cex}{Character expansion for the title.}
 \item{pad.mult}{How much higher to make the tab relative to the label.}
 \item{radius}{What proportion of the tab corners to round off.}
}
\value{
 nil
}
\details{
 \samp{tab.title} displays the plot title in a colored tab. The tab can be
 rounded at the upper corners by specifying the proportion of the tab
 height to be rounded as a number between 0 and 1. If the tab is too high
 to fit on the figure region, a warning will be displayed and the tab will
 still be shown. 
}
\author{Jim Lemon}
\seealso{\link{polygon}}
\examples{
 testx<-matrix(cumsum(rnorm(30)^2)+1,nrow=10)
 stackpoly(testx,main="",
  xaxlab=c("One","Two","Three","Four","Five",
  "Six","Seven","Eight","Nine","Ten"),staxx=TRUE)
 tab.title("Three Squiggly Lines",tab.col="yellow",radius=0.5)
}
\keyword{misc}