Rev 31 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed
\name{bdp}
\alias{bdp}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{ ~~function to do ... ~~ }
\description{
~~ A concise (1-5 lines) description of what the function does. ~~
}
\usage{
bdp(...)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
\item{\dots}{ ~~Describe \code{\dots} here~~ }
}
\details{
~~ If necessary, more details than the description above ~~
}
\value{
~Describe the value returned
If it is a LIST, use
\item{comp1 }{Description of 'comp1'}
\item{comp2 }{Description of 'comp2'}
...
}
\references{ ~put references to the literature/web site here ~ }
\author{ ~~who you are~~ }
\note{ ~~further notes~~
~Make other sections like Warning with \section{Warning }{....} ~
}
\seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
\examples{
##---- Should be DIRECTLY executable !! ----
##-- ==> Define data, use random,
##-- or do help(data=index) for the standard data sets.
## The function is currently defined as
function (...)
{
single <- FALSE
args <- list(...)
if (!length(args))
args <- as.list(.Pars)
else {
if (all(unlist(lapply(args, is.character))))
args <- as.list(unlist(args))
if (length(args) == 1) {
if (is.list(args[[1]]) | is.null(args[[1]]))
args <- args[[1]]
else if (is.null(names(args)))
single <- TRUE
}
}
value <- .Internal(par(args))
if (single)
value <- value[[1]]
if (!is.null(names(args)))
invisible(value)
else value
}
}
% Add one or more standard keywords, see file 'KEYWORDS' in the
% R documentation directory.
\keyword{ ~kwd1 }
\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line