File: fullaxis.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 (51 lines) | stat: -rwxr-xr-x 2,072 bytes parent folder | download | duplicates (7)
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
\name{fullaxis}
\alias{fullaxis}
\title{Add an axis with a line to the edge of the plot}
\description{
  As \samp{axis}, but draws a "box" line in the same color as the axis.
}
\usage{
 fullaxis(side=1,at=NULL,labels=TRUE,line=NA,pos=NA,outer=FALSE,
 font=NA,lty="solid",lwd=1,lwd.ticks=lwd,col=NULL,col.ticks=NULL,
 hadj=NA,padj=NA,...)
}
\arguments{
 \item{side}{The side of the plot to draw the axis}
 \item{at}{Optional positions in user units for the tick marks.}
 \item{labels}{Optional labels for the tick marks.}
 \item{line}{Optional line into the margin.}
 \item{pos}{Optional position in user units for the axis. Defaults to the edge.}
 \item{outer}{Whether to use the outer margin as for \samp{axis}.}
 \item{font}{Font for the labels.}
 \item{lty}{Line type.}
 \item{lwd}{Line width for the axis.}
 \item{lwd.ticks}{Line width for the ticks.}
 \item{col}{color for the axis and tick marks. See Details for label color.}
 \item{col.ticks}{Color for the tick marks if different from the axis.}
 \item{hadj,padj}{Justification for the labels. See \samp{axis}.}
 \item{...}{Further arguments passed to \samp{axis}.}
}
\details{
 \samp{fullaxis} draws a line to the edges of the plot and then calls
 \samp{axis} to draw an axis. \samp{fullaxis} is mainly useful for drawing a
 colored axis on a boxed plot. In order to get the tick labels the same color as
 the axis and ticks, pass the \samp{col.axis} argument (as part of ...) as well
 as \samp{col}. See the example for some useful tips.
}
\value{
 The positions of the tick marks in user units.
}
\author{ Jim Lemon }
\seealso{ \link{axis}}
\examples{
 plot(runif(20,-1,1),runif(20,-1,1),xlim=c(-1,1.5),main="Demo of fullaxis",
  xlab="X",ylab="Y",axes=FALSE)
 fullaxis(1,col="red",col.axis="red")
 fullaxis(2,col="blue",col.axis="blue")
 fullaxis(4,at=c(-0.5,0,0.5),labels=c("Negative","Zero","Positive"),pos=1.2,
  col="green",las=1)
 # add a top line to complete the "box"
 xylim<-par("usr")
 segments(xylim[1],xylim[4],xylim[2],xylim[4])
}
\keyword{misc}