File: printf.Verbose.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 (44 lines) | stat: -rw-r--r-- 1,275 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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  Verbose.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{printf.Verbose}
\alias{printf.Verbose}
\alias{Verbose.printf}
\alias{printf,Verbose-method}

\title{Formats and prints object if above threshold}

\description{
  Formats and prints object if above threshold.
  The output is indented according to \code{\link[R.utils:enter.Verbose]{*enter}()}/\code{\link[R.utils:exit.Verbose]{*exit}()}
  calls.
}

\usage{
\method{printf}{Verbose}(this, fmtstr, ..., level=this$defaultLevel, timestamp=this$.timestamp)
}

\arguments{
 \item{...}{Objects to be passed to \code{\link[base]{sprintf}}().}
 \item{fmtstr}{A \code{\link[base]{character}} string specify the printf format string.}
 \item{level}{A \code{\link[base]{numeric}} value to be compared to the threshold.}
 \item{timestamp}{A \code{\link[base]{logical}} indicating if output should start with a
    timestamp, or not.}
}

\value{
  Returns nothing.
}

\author{Henrik Bengtsson}

\seealso{
  For more information see \code{\link{Verbose}}.
}
\keyword{internal}
\keyword{methods}