Subversion Repositories bdplot

Rev

Rev 5 | Rev 7 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 5 Rev 6
1 
\name{bdplot}
 1 
\name{bdplot}
2 
\alias{bdplot}
 2 
\alias{bdplot}
3 
%- Also NEED an '\alias' for EACH other topic documented here.
 3 
%- Also NEED an '\alias' for EACH other topic documented here.
4 
\title{A plotting overlayer}
 4 
\title{A plotting overlayer}
5 
\description{
 5 
\description{
6 
  This is the plotting function in the bdplot package. It corresponds to
 6 
  This is the plotting function in the bdgraphics package. It corresponds to
7 
  plot from the graphics package but benefits from the variable sharing
 7 
  plot from the graphics package but benefits from the variable sharing
8 
  provided by the bdplot package.
 8 
  provided by the bdplot package.
9 
}
 9 
}
10 
\usage{
 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,...)
 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 
}
 12 
}
13 
%- maybe also 'usage' for other objects documented here.
 13 
%- maybe also 'usage' for other objects documented here.
14 
\arguments{
 14 
\arguments{
15 
  \item{x}{The first or only dimension to plot. May be of class
 15 
  \item{x}{The first or only dimension to plot. May be of class
16 
    numeric, histogram, acf, ...}
 16 
    numeric, histogram, acf, ...}
17 
  \item{y}{ Optional second coordinate if \code{x} is numeric. If
 17 
  \item{y}{ Optional second coordinate if \code{x} is numeric. If
18 
    \code{x} is not numeric, \code{y} is ignored}
 18 
    \code{x} is not numeric, \code{y} is ignored}
19 
  \item{z}{ ~~Describe \code{z} here~~ }
 19 
  \item{z}{Optional third coordinate. Used in image plotting.}
- 
 
 20 
  The rest of the named arguments can also be set with bdp().
20 
  \item{cex.plot}{ ~~Describe \code{cex.plot} here~~ }
 21 
  \item{cex.plot}{See cex in ?plot. Size of plotting characters.}
21 
  \item{xlab}{ ~~Describe \code{xlab} here~~ }
 22 
  \item{xlab}{}
22 
  \item{ylab}{ ~~Describe \code{ylab} here~~ }
 23 
  \item{ylab}{}
23 
  \item{xlim}{ ~~Describe \code{xlim} here~~ }
 24 
  \item{xlim}{}
24 
  \item{ylim}{ ~~Describe \code{ylim} here~~ }
 25 
  \item{ylim}{}
25 
  \item{col}{ ~~Describe \code{col} here~~ }
 26 
  \item{col}{}
26 
  \item{type}{ ~~Describe \code{type} here~~ }
 27 
  \item{type}{}
27 
  \item{\dots}{ ~~Describe \code{\dots} here~~ }
 28 
  \item{\dots}{Arguments passed to the relevant plotting function.}
28 
}
 29 
}
29 
\details{
 30 
\details{
30 
  ~~ If necessary, more details than the description above ~~
 - 
 
31 
}
 31 
}
32 
\value{
 32 
\value{
33 
  ~Describe the value returned
 33 
Nothing is returned.
34 
  If it is a LIST, use
 - 
 
35 
  \item{comp1 }{Description of 'comp1'}
 - 
 
36 
  \item{comp2 }{Description of 'comp2'}
 - 
 
37 
  ...
 - 
 
38 
}
 34 
}
39 
\references{ ~put references to the literature/web site here ~ }
 35 
\references{SVN: http://svn.imm.dtu.dk/svn/bdplot}
40 
\author{ ~~who you are~~ }
 36 
\author{Peder Bacher, Philip Delff}
41 
\note{ ~~further notes~~
37 
\note{
42 
 
 - 
 
43 
 ~Make other sections like Warning with \section{Warning }{....} ~
 - 
 
44 
}
 38 
}
45 
\seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
 39 
\seealso{bdgraphics, bdp, bdopen, bd.devoff}
46 
\examples{
 40 
\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")
 41 
bdp(file="test.ps")
53 
bdopen()
 42 
bdopen()
54 
bdplot(1:10,rnorm(10))
 43 
bdplot(1:10,rnorm(10))
55 
bdxyadd(1:10,rnorm(10),col=2)
 44 
bdxyadd(1:10,rnorm(10),col=2)
56 
bd.devoff()
 45 
bd.devoff()
57 
  }
 46 
  }
58 
 
 47 
 
59 
% Add one or more standard keywords, see file 'KEYWORDS' in the
 48 
% Add one or more standard keywords, see file 'KEYWORDS' in the
60 
% R documentation directory.
 49 
% R documentation directory.
61 
\keyword{ ~kwd1 }
 50 
\keyword{ Plotting }
62 
\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
 - 
 
- 
 
 51 
 
63 
 
 52 
 
64 
 
 53