Subversion Repositories bdplot

Rev

Rev 38 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 38 Rev 43
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 bdgraphics 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}{Optional third coordinate. Used in image plotting.}
19
  \item{z}{Optional third coordinate. Used in image plotting.}
20
  The rest of the named arguments can also be set with bdp().
20
  The rest of the named arguments can also be set with bdp().
21
  \item{cex.plot}{See cex in ?plot. Size of plotting characters.}
21
  \item{cex.plot}{See cex in ?plot. Size of plotting characters.}
22
  \item{xaxt, yaxt} In extension to the functionality provided by these
22
  \item{xaxt, yaxt}{In extension to the functionality provided by these
23
  arguments in \code{plot}, they may here also be assigned a function
23
  arguments in \code{plot}, they may here also be assigned a function
24
  that will draw the axis with x or y, respectively, as input. If "axis"
24
  that will draw the axis with x or y, respectively, as input. If "axis"
25
  (as character string) is given, a special call to the axis function is
25
  (as character string) is given, a special call to the axis function is
26
  performed. See also xaxt.in, yaxt.in.
26
  performed. See also xaxt.in, yaxt.in.}
27
  \item{xaxt.in, yaxt.in} If \code{xaxt} or \code{yaxt} are assigned a
27
  \item{xaxt.in, yaxt.in}{If \code{xaxt} or \code{yaxt} are assigned a
28
  function, and this function must have something else than \code{x} or
28
  function, and this function must have something else than \code{x} or
29
  \code{y} respectively as input, the inputs should be assigned to
29
  \code{y} respectively as input, the inputs should be assigned to
30
  theses options.
30
  theses options.}
31
  \item{xlab, ylab}{See ?par. If set to NA, no label will be shown, and margin
31
  \item{xlab, ylab}{See ?par. If set to NA, no label will be shown, and margin
32
  will be reduced (set to corresponding bdp()$mar.nolab). NULL will
32
  will be reduced (set to corresponding bdp()$mar.nolab). NULL will
33
  result in default labels like x, y, and Index. It is not possible to
33
  result in default labels like x, y, and Index. It is not possible to
34
  get the automatically generated defaul R strings. To get no label but
34
  get the automatically generated defaul R strings. To get no label but
35
  margin as mar.lab use "". }
35
  margin as mar.lab use "". }
36
  \item{col, type, xlim, ylim}{See ?par.}
36
  \item{col, type, xlim, ylim}{See ?par.}
37
  \item{\dots}{Arguments passed to the relevant plotting function.}
37
  \item{\dots}{Arguments passed to the relevant plotting function.}
38
}
38
}
39
\details{
39
\details{
40
 bdplot is a plotting wrapper which calls relevant methods depending on
40
 bdplot is a plotting wrapper which calls relevant methods depending on
41
  the input. 
41
  the input. 
42
}
42
}
43
\value{
43
\value{
44
Nothing is returned.
44
Nothing is returned.
45
}
45
}
46
\references{SVN: http://svn.imm.dtu.dk/svn/bdplot/bdgraphics}
46
\references{SVN: http://svn.imm.dtu.dk/svn/bdplot/bdgraphics}
47
\author{Peder Bacher, Philip Delff}
47
\author{Peder Bacher, Philip Delff}
48
%\note{
48
%\note{
49
%}
49
%}
50
\seealso{bdgraphics, bdp, bdopen, bd.devoff}
50
\seealso{bdgraphics, bdp, bdopen, bd.devoff}
51
\examples{
51
\examples{
52
# bdp(file="test.ps")
52
# bdp(file="test.ps")
53
bdopen()
53
bdopen()
54
bdplot(1:10,rnorm(10))
54
bdplot(1:10,rnorm(10))
55
bdpoints(1:10,rnorm(10),col=2)
55
bdpoints(1:10,rnorm(10),col=2)
56
bd.devoff()
56
bd.devoff()
57
  }
57
  }
58
 
58
 
59
% Add one or more standard keywords, see file 'KEYWORDS' in the
59
% Add one or more standard keywords, see file 'KEYWORDS' in the
60
% R documentation directory.
60
% R documentation directory.
61
\keyword{hplot}
61
\keyword{hplot}
62
 
62
 
63
 
63
 
64
 
64