| 5 |
pdel |
1 |
\name{bdxyadd}
|
|
|
2 |
\alias{bdxyadd}
|
|
|
3 |
%- Also NEED an '\alias' for EACH other topic documented here.
|
|
|
4 |
\title{ ~~function to do ... ~~ }
|
|
|
5 |
\description{
|
|
|
6 |
~~ A concise (1-5 lines) description of what the function does. ~~
|
|
|
7 |
}
|
|
|
8 |
\usage{
|
|
|
9 |
bdxyadd(x, y = NULL, type = "p", col = prm$col, lwd = prm$lwd, pch = prm$pch, ...)
|
|
|
10 |
}
|
|
|
11 |
%- maybe also 'usage' for other objects documented here.
|
|
|
12 |
\arguments{
|
|
|
13 |
\item{x}{ ~~Describe \code{x} here~~ }
|
|
|
14 |
\item{y}{ ~~Describe \code{y} here~~ }
|
|
|
15 |
\item{type}{ ~~Describe \code{type} here~~ }
|
|
|
16 |
\item{col}{ ~~Describe \code{col} here~~ }
|
|
|
17 |
\item{lwd}{ ~~Describe \code{lwd} here~~ }
|
|
|
18 |
\item{pch}{ ~~Describe \code{pch} here~~ }
|
|
|
19 |
\item{\dots}{ ~~Describe \code{\dots} here~~ }
|
|
|
20 |
}
|
|
|
21 |
\details{
|
|
|
22 |
~~ If necessary, more details than the description above ~~
|
|
|
23 |
}
|
|
|
24 |
\value{
|
|
|
25 |
~Describe the value returned
|
|
|
26 |
If it is a LIST, use
|
|
|
27 |
\item{comp1 }{Description of 'comp1'}
|
|
|
28 |
\item{comp2 }{Description of 'comp2'}
|
|
|
29 |
...
|
|
|
30 |
}
|
|
|
31 |
\references{ ~put references to the literature/web site here ~ }
|
|
|
32 |
\author{ ~~who you are~~ }
|
|
|
33 |
\note{ ~~further notes~~
|
|
|
34 |
|
|
|
35 |
~Make other sections like Warning with \section{Warning }{....} ~
|
|
|
36 |
}
|
|
|
37 |
\seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
|
|
|
38 |
\examples{
|
|
|
39 |
##---- Should be DIRECTLY executable !! ----
|
|
|
40 |
##-- ==> Define data, use random,
|
|
|
41 |
##-- or do help(data=index) for the standard data sets.
|
|
|
42 |
|
|
|
43 |
## The function is currently defined as
|
|
|
44 |
function (x, y = NULL, type = "p", col = prm$col, lwd = prm$lwd,
|
|
|
45 |
pch = prm$pch, ...)
|
|
|
46 |
{
|
|
|
47 |
if (type == "p") {
|
|
|
48 |
prm <- .BDPars
|
|
|
49 |
if (!is.null(y)) {
|
|
|
50 |
points(x, y, cex = prm$cex.plot, pch = prm$pch, col = col,
|
|
|
51 |
...)
|
|
|
52 |
}
|
|
|
53 |
else {
|
|
|
54 |
points(x, cex = prm$cex.plot, pch = prm$pch, col = col,
|
|
|
55 |
...)
|
|
|
56 |
}
|
|
|
57 |
}
|
|
|
58 |
else if (type == "l") {
|
|
|
59 |
if (!is.null(y)) {
|
|
|
60 |
lines(x, y, col = col, lwd = lwd, ...)
|
|
|
61 |
}
|
|
|
62 |
else {
|
|
|
63 |
lines(x, col = col, lwd = lwd, ...)
|
|
|
64 |
}
|
|
|
65 |
}
|
|
|
66 |
else if (type == "lp" | type == "pl") {
|
|
|
67 |
if (!is.null(y)) {
|
|
|
68 |
points(x, y, cex = prm$cex.plot, pch = prm$pch, col = col,
|
|
|
69 |
...)
|
|
|
70 |
lines(x, y, col = col, lwd = lwd, ...)
|
|
|
71 |
}
|
|
|
72 |
else {
|
|
|
73 |
points(x, cex = prm$cex.plot, pch = prm$pch, col = col,
|
|
|
74 |
...)
|
|
|
75 |
lines(x, col = col, lwd = lwd, ...)
|
|
|
76 |
}
|
|
|
77 |
}
|
|
|
78 |
}
|
|
|
79 |
}
|
|
|
80 |
% Add one or more standard keywords, see file 'KEYWORDS' in the
|
|
|
81 |
% R documentation directory.
|
|
|
82 |
\keyword{ ~kwd1 }
|
|
|
83 |
\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
|