| 5 |
pdel |
1 |
\name{bdopen}
|
|
|
2 |
\alias{bdopen}
|
|
|
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 |
bdopen(filename = prm$filename)
|
|
|
10 |
}
|
|
|
11 |
%- maybe also 'usage' for other objects documented here.
|
|
|
12 |
\arguments{
|
|
|
13 |
\item{filename}{ ~~Describe \code{filename} here~~ }
|
|
|
14 |
}
|
|
|
15 |
\details{
|
|
|
16 |
~~ If necessary, more details than the description above ~~
|
|
|
17 |
}
|
|
|
18 |
\value{
|
|
|
19 |
~Describe the value returned
|
|
|
20 |
If it is a LIST, use
|
|
|
21 |
\item{comp1 }{Description of 'comp1'}
|
|
|
22 |
\item{comp2 }{Description of 'comp2'}
|
|
|
23 |
...
|
|
|
24 |
}
|
|
|
25 |
\references{ ~put references to the literature/web site here ~ }
|
|
|
26 |
\author{ ~~who you are~~ }
|
|
|
27 |
\note{ ~~further notes~~
|
|
|
28 |
|
|
|
29 |
~Make other sections like Warning with \section{Warning }{....} ~
|
|
|
30 |
}
|
|
|
31 |
\seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
|
|
|
32 |
\examples{
|
|
|
33 |
##---- Should be DIRECTLY executable !! ----
|
|
|
34 |
##-- ==> Define data, use random,
|
|
|
35 |
##-- or do help(data=index) for the standard data sets.
|
|
|
36 |
|
|
|
37 |
## The function is currently defined as
|
|
|
38 |
function (filename = prm$filename)
|
|
|
39 |
{
|
|
|
40 |
prm <- .BDPars
|
|
|
41 |
if (!is.na(filename)) {
|
|
|
42 |
if (!is.null(prm$figdir) & !is.na(prm$figdir)) {
|
|
|
43 |
prm$filename <- paste(prm$figdir, prm$filename, sep = "")
|
|
|
44 |
}
|
|
|
45 |
nchars <- nchar(prm$filename)
|
|
|
46 |
if (any(substr(prm$filename, nchars - 2, nchars) == ".ps",
|
|
|
47 |
substr(prm$filename, nchars - 3, nchars) == ".eps")) {
|
|
|
48 |
m <- {
|
|
|
49 |
cat("B/D plotting writing to postscript file\n")
|
|
|
50 |
postscript(file = prm$filename, width = prm$width,
|
|
|
51 |
height = prm$height, paper = "special", horizontal = FALSE,
|
|
|
52 |
family = "Helvetica")
|
|
|
53 |
}
|
|
|
54 |
}
|
|
|
55 |
else if (substr(prm$filename, nchars - 3, nchars) ==
|
|
|
56 |
".pdf") {
|
|
|
57 |
pdf(file = prm$filename, width = prm$width, height = prm$height)
|
|
|
58 |
}
|
|
|
59 |
}
|
|
|
60 |
else {
|
|
|
61 |
x11()
|
|
|
62 |
}
|
|
|
63 |
par(mfrow = prm$mfrow)
|
|
|
64 |
}
|
|
|
65 |
}
|
|
|
66 |
% Add one or more standard keywords, see file 'KEYWORDS' in the
|
|
|
67 |
% R documentation directory.
|
|
|
68 |
\keyword{ ~kwd1 }
|
|
|
69 |
\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
|