File: utils-decor.Rd

package info (click to toggle)
fbasics 4052.98-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,020 kB
  • sloc: ansic: 738; makefile: 14
file content (68 lines) | stat: -rw-r--r-- 1,295 bytes parent folder | download | duplicates (2)
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
\name{decor}
\alias{decor}

\alias{hgrid}
\alias{vgrid}
\alias{boxL}
\alias{box_}
\alias{copyright}

\title{Functions for decorating plots}

\description{
  Functions for decorating plots.
}

\usage{
decor()

hgrid(ny = NULL, ...) 
vgrid(nx = NULL, ...) 

boxL(col = "white") 
box_(col = c("white", "black")) 

copyright()
}

\arguments{
  \item{col}{
    the color of the background, \code{"black"} and foreground
    \code{"white"} lines of the box.
  }
  \item{nx, ny}{
    number of cells of the grid in \code{x} or \code{y} direction. When \code{NULL}, 
    as per default, the grid aligns with the tick marks on the 
    corresponding default axis (i.e., tick marks as computed by axTicks). 
  } 
  \item{\dots}{
    additional arguments passed to the \code{grid()} function.
  }
}

\details{
  
  \code{decor} is equivalent to \code{hgrid()} followed by \code{boxL()}.
    
  \code{hgrid} creates horizontal grid lines.

  \code{vgrid} creates vertical grid lines.

  \code{boxL}  creates an L-shaped box

  \code{box_} creates a bottom line box.

  \code{copyright} adds Rmetrics copyright to a plot.

}

\examples{
plot(x = rnorm(100), type = "l", col = "red", 
     xlab = "", ylab = "Variates", las = 1)
title("Normal Deviates", adj = 0)
hgrid()
boxL()
copyright()
}

\keyword{hplot}