Subversion Repositories bdplot

Rev

Rev 5 | Show entire file | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 5 Rev 37
Line 1... Line 1...
1 
\name{bdlegend}
 1 
\name{bdlegend}
2 
\alias{bdlegend}
 2 
\alias{bdlegend}
3 
%- Also NEED an '\alias' for EACH other topic documented here.
 3 
%- Also NEED an '\alias' for EACH other topic documented here.
4 
\title{ ~~function to do ... ~~ }
 4 
\title{A legend overlayer}
5 
\description{
 5 
\description{
6 
  ~~ A concise (1-5 lines) description of what the function does. ~~
 6 
  This is the legend function of bdgraphics. It is simply a wrapper for
- 
 
 7 
  legend that uses the relevant bdp() parameters as inputs.
7 
}
 8 
}
8 
\usage{
 9 
\usage{
9 
bdlegend(legend, prm, cex = prm$cex.legend, pos = prm$pos.legend, bg = prm$bg.legend, ...)
 10 
bdlegend(legend,x=bdp()$pos.legend,col=bdp()$col,bg=bdp()$bg.legend,cex=bdp()$cex.legend,...)
10 
}
 11 
}
11 
%- maybe also 'usage' for other objects documented here.
 12 
%- maybe also 'usage' for other objects documented here.
12 
\arguments{
 13 
\arguments{
13 
  \item{legend}{ ~~Describe \code{legend} here~~ }
 - 
 
14 
  \item{prm}{ ~~Describe \code{prm} here~~ }
 - 
 
15 
  \item{cex}{ ~~Describe \code{cex} here~~ }
 - 
 
16 
  \item{pos}{ ~~Describe \code{pos} here~~ }
 - 
 
17 
  \item{bg}{ ~~Describe \code{bg} here~~ }
 - 
 
18 
  \item{\dots}{ ~~Describe \code{\dots} here~~ }
 - 
 
19 
}
 - 
 
20 
\details{
 - 
 
21 
  ~~ If necessary, more details than the description above ~~
 - 
 
22 
}
 - 
 
23 
\value{
 - 
 
24 
  ~Describe the value returned
 - 
 
25 
  If it is a LIST, use
 - 
 
26 
  \item{comp1 }{Description of 'comp1'}
 - 
 
27 
  \item{comp2 }{Description of 'comp2'}
 - 
 
28 
  ...
 - 
 
29 
}
 - 
 
30 
\references{ ~put references to the literature/web site here ~ }
 - 
 
31 
\author{ ~~who you are~~ }
 - 
 
32 
\note{ ~~further notes~~
- 
 
33 
 
 - 
 
34 
 ~Make other sections like Warning with \section{Warning }{....} ~
 - 
 
35 
}
 - 
 
36 
\seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
 - 
 
37 
\examples{
 14 
  See ?legend
38 
##---- Should be DIRECTLY executable !! ----
 - 
 
39 
##-- ==>  Define data, use random,
 - 
 
40 
##--	or do  help(data=index)  for the standard data sets.
 - 
 
41 
 
 - 
 
42 
## The function is currently defined as
 - 
 
43 
function (legend, prm, cex = prm$cex.legend, pos = prm$pos.legend,
- 
 
44 
    bg = prm$bg.legend, ...)
- 
 
45 
{
 - 
 
46 
    legend(x = pos, cex = cex, legend = legend, bg = bg, ...)
 - 
 
47 
  }
 - 
 
48 
}
 15 
}
- 
 
 16 
%\details{
- 
 
 17 
%  ~~ If necessary, more details than the description above ~~
- 
 
 18 
%}
- 
 
 19 
% \value{
- 
 
 20 
%   ~Describe the value returned
- 
 
 21 
%   If it is a LIST, use
- 
 
 22 
%   \item{comp1 }{Description of 'comp1'}
- 
 
 23 
%   \item{comp2 }{Description of 'comp2'}
- 
 
 24 
%   ...
- 
 
 25 
% }
- 
 
 26 
%\references{ ~put references to the literature/web site here ~ }
- 
 
 27 
\author{Peder Bacher <pb@imm.dtu.dk>, Philip Delff <pdel@imm.dtu.dk>}
- 
 
 28 
% \note{ ~~further notes~~
- 
 
 29 
%  ~Make other sections like Warning with \section{Warning }{....} ~
- 
 
 30 
% }
- 
 
 31 
%\seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
- 
 
 32 
%\examples{
- 
 
 33 
%
- 
 
 34 
%}
49 
% Add one or more standard keywords, see file 'KEYWORDS' in the
 35 
% Add one or more standard keywords, see file 'KEYWORDS' in the
50 
% R documentation directory.
 36 
% R documentation directory.
51 
\keyword{ ~kwd1 }
 37 
\keyword{aplot}
52 
\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
 -