Subversion Repositories bdplot

Rev

Rev 31 | Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
5 pdel 1
\name{bdp}
2
\alias{bdp}
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
bdp(...)
10
}
11
%- maybe also 'usage' for other objects documented here.
12
\arguments{
13
  \item{\dots}{ ~~Describe \code{\dots} 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 (...) 
39
{
40
    single <- FALSE
41
    args <- list(...)
42
    if (!length(args)) 
43
        args <- as.list(.Pars)
44
    else {
45
        if (all(unlist(lapply(args, is.character)))) 
46
            args <- as.list(unlist(args))
47
        if (length(args) == 1) {
48
            if (is.list(args[[1]]) | is.null(args[[1]])) 
49
                args <- args[[1]]
50
            else if (is.null(names(args))) 
51
                single <- TRUE
52
        }
53
    }
54
    value <- .Internal(par(args))
55
    if (single) 
56
        value <- value[[1]]
57
    if (!is.null(names(args))) 
58
        invisible(value)
59
    else value
60
  }
61
}
62
% Add one or more standard keywords, see file 'KEYWORDS' in the
63
% R documentation directory.
64
\keyword{ ~kwd1 }
65
\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line