Subversion Repositories bdplot

Rev

Rev 5 | Rev 34 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 5 Rev 31
Line 1... Line 1...
1 
\name{bdp}
 1 
\name{bdp}
2 
\alias{bdp}
 2 
\alias{bdp}
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{Set or query graphical parameters with bdgraphics}
5 
\description{
 5 
\description{
6 
  ~~ A concise (1-5 lines) description of what the function does. ~~
 6 
`bdp` is a parallel to par, working ideally the same way but controlling
- 
 
 7 
graphical parameters through the bdgraphics plotting overlayer.
7 
}
 8 
}
8 
\usage{
 9 
\usage{
9 
bdp(...)
 10 
bdp(...)
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{\dots}{ ~~Describe \code{\dots} here~~ }
 14 
  \item{\dots}{To be documented. A lot of graphical parameters. See the
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
 15 
    output of bdp().}
21 
  \item{comp1 }{Description of 'comp1'}
 - 
 
22 
  \item{comp2 }{Description of 'comp2'}
 - 
 
23 
  ...
 - 
 
24 
}
 16 
}
- 
 
 17 
%\details{
- 
 
 18 
%  ~~ If necessary, more details than the description above ~~
- 
 
 19 
%}
- 
 
 20 
%\value{
- 
 
 21 
%  ~Describe the value returned
- 
 
 22 
%  If it is a LIST, use
- 
 
 23 
%  \item{comp1 }{Description of 'comp1'}
- 
 
 24 
%  \item{comp2 }{Description of 'comp2'}
- 
 
 25 
%  ...
- 
 
 26 
%}
25 
\references{ ~put references to the literature/web site here ~ }
 27 
\references{ ~put references to the literature/web site here ~ }
26 
\author{ ~~who you are~~ }
 28 
\author{ ~~who you are~~ }
27 
\note{ ~~further notes~~
29 
\note{ ~~further notes~~
28 
 
 30 
 
29 
 ~Make other sections like Warning with \section{Warning }{....} ~
 31 
 ~Make other sections like Warning with \section{Warning }{....} ~
30 
}
 32 
}
31 
\seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
 33 
\seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
32 
\examples{
 34 
\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))
35 
bdp(file="test.ps")
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 
}
 36 
}
62 
% Add one or more standard keywords, see file 'KEYWORDS' in the
 37 
% Add one or more standard keywords, see file 'KEYWORDS' in the
63 
% R documentation directory.
 38 
% R documentation directory.
64 
\keyword{ ~kwd1 }
 39 
\keyword{iplot}
65 
\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
 40 
%\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line