Subversion Repositories bdplot

Rev

Rev 6 | Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
5 pdel 1
\name{bdplot}
2
\alias{bdplot}
3
%- Also NEED an '\alias' for EACH other topic documented here.
4
\title{A plotting overlayer}
5
\description{
6
  This is the plotting function in the bdplot package. It corresponds to
7
  plot from the graphics package but benefits from the variable sharing
8
  provided by the bdplot package.
9
}
10
\usage{
11
bdplot(x, y=NULL, z=NULL,cex.plot=bdp()$cex.plot,xaxt="n",xlab=bdp()$xlab, ylab=bdp()$ylab,xlim=range(x,bdp()$xlim,na.rm=TRUE),ylim=range(bdp()$ylim,y,na.rm=TRUE),col=bdp()$col,main=NULL,type=bdp()$type,border=bdp()$border,...)
12
}
13
%- maybe also 'usage' for other objects documented here.
14
\arguments{
15
  \item{x}{The first or only dimension to plot. May be of class
16
    numeric, histogram, acf, ...}
17
  \item{y}{ Optional second coordinate if \code{x} is numeric. If
18
    \code{x} is not numeric, \code{y} is ignored}
19
  \item{z}{ ~~Describe \code{z} here~~ }
20
  \item{cex.plot}{ ~~Describe \code{cex.plot} here~~ }
21
  \item{xlab}{ ~~Describe \code{xlab} here~~ }
22
  \item{ylab}{ ~~Describe \code{ylab} here~~ }
23
  \item{xlim}{ ~~Describe \code{xlim} here~~ }
24
  \item{ylim}{ ~~Describe \code{ylim} here~~ }
25
  \item{col}{ ~~Describe \code{col} here~~ }
26
  \item{type}{ ~~Describe \code{type} here~~ }
27
  \item{\dots}{ ~~Describe \code{\dots} here~~ }
28
}
29
\details{
30
  ~~ If necessary, more details than the description above ~~
31
}
32
\value{
33
  ~Describe the value returned
34
  If it is a LIST, use
35
  \item{comp1 }{Description of 'comp1'}
36
  \item{comp2 }{Description of 'comp2'}
37
  ...
38
}
39
\references{ ~put references to the literature/web site here ~ }
40
\author{ ~~who you are~~ }
41
\note{ ~~further notes~~ 
42
 
43
 ~Make other sections like Warning with \section{Warning }{....} ~
44
}
45
\seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
46
\examples{
47
##---- Should be DIRECTLY executable !! ----
48
##-- ==>  Define data, use random,
49
##--	or do  help(data=index)  for the standard data sets.
50
 
51
## The function is currently defined as
52
bdp(file="test.ps")
53
bdopen()
54
bdplot(1:10,rnorm(10))
55
bdxyadd(1:10,rnorm(10),col=2)
56
bd.devoff()
57
  }
58
 
59
% Add one or more standard keywords, see file 'KEYWORDS' in the
60
% R documentation directory.
61
\keyword{ ~kwd1 }
62
\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
63