File: getVerbose.Arguments.Rd

package info (click to toggle)
r-cran-r.utils 2.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,936 kB
  • sloc: sh: 18; makefile: 6
file content (56 lines) | stat: -rwxr-xr-x 1,873 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
53
54
55
56
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  Arguments.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{Arguments$getVerbose}
\alias{Arguments$getVerbose}
\alias{getVerbose.Arguments}
\alias{Arguments.getVerbose}
\alias{getVerbose,Arguments-method}

\title{Coerces to Verbose object}

\description{
 Coerces to Verbose object.
}

\usage{
## Static method (use this):
## Arguments$getVerbose(verbose, defaultThreshold=-1, useNullVerbose=TRUE, ...,
##   .name=NULL)

## Don't use the below:
\method{getVerbose}{Arguments}(static, verbose, defaultThreshold=-1, useNullVerbose=TRUE, ..., .name=NULL)
}

\arguments{
  \item{verbose}{A single object. If a \code{\link{Verbose}}, it is immediately
     returned.  If a \code{\link[base]{numeric}} value, it is used as the threshold.
     Otherwise the object is coerced to a \code{\link[base]{logical}} value and if \code{\link[base:logical]{TRUE}},
     the threshold is \code{defaultThreshold}.}
  \item{defaultThreshold}{A \code{\link[base]{numeric}} value for the default threshold, if
      \code{verbose} was interpreted as a \code{\link[base]{logical}} value.}
  \item{useNullVerbose}{If \code{verbose} can be interpreted as \code{\link[base:logical]{FALSE}},
      return a \code{\link{NullVerbose}} object if \code{\link[base:logical]{TRUE}}.}
  \item{...}{Passed to the constructor of \code{\link{Verbose}}.}
  \item{.name}{A \code{\link[base]{character}} string for name used in error messages.}
}

\value{
 Returns a \code{\link{Verbose}} (or a \code{\link{NullVerbose}}) object.
}

\author{Henrik Bengtsson}

\seealso{
  For more information see \code{\link{Arguments}}.
}


\keyword{internal}
\keyword{methods}
\keyword{IO}