File: doCall.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (52 lines) | stat: -rw-r--r-- 1,842 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  doCall.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{doCall}
\alias{doCall.default}
\alias{doCall}

\title{Executes a function call with option to ignore unused arguments}

\description{
  Executes a function call with option to ignore unused arguments.
}

\usage{
\method{doCall}{default}(.fcn, ..., args=NULL, alwaysArgs=NULL, .functions=list(.fcn),
  .ignoreUnusedArgs=TRUE, envir=parent.frame())
}

\arguments{
 \item{.fcn}{A \code{\link[base]{function}} or a \code{\link[base]{character}} string specifying the name
   of a \code{\link[base]{function}} to be called.}
 \item{...}{Named arguments to be passed to the function.}
 \item{args}{A \code{\link[base]{list}} of additional named arguments that will be appended
   to the above arguments.}
 \item{alwaysArgs}{A \code{\link[base]{list}} of additional named arguments that will be
   appended to the above arguments and that will \emph{never} be ignore.}
 \item{.functions}{A \code{\link[base]{list}} of \code{\link[base]{function}}:s or names of functions.  This
   can be used to control which arguments are passed.}
 \item{.ignoreUnusedArgs}{If \code{\link[base:logical]{TRUE}}, arguments that are not accepted by the
   function, will not be passed to it. Otherwise, all arguments are passed.}
 \item{envir}{An \code{\link[base]{environment}} in which to evaluate the call.}
}

\examples{
  doCall("plot", x=1:10, y=sin(1:10), col="red", dummyArg=54,
         alwaysArgs=list(xlab="x", ylab="y"),
         .functions=c("plot", "plot.xy"))
}

\seealso{
  \code{\link[base]{do.call}}().
}

\author{Henrik Bengtsson}


\keyword{programming}