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

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

\title{Concatenates and prints objects if above threshold}

\description{
  Concatenates and prints objects 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{cat}{Verbose}(this, ..., sep="", newline=TRUE, level=this$defaultLevel, timestamp=this$.timestamp)
}

\arguments{
 \item{...}{Objects to be passed to \code{\link[base]{cat}}().}
 \item{sep}{The default separator \code{\link[base]{character}} string.}
 \item{newline}{If \code{\link[base:logical]{TRUE}}, a newline is added at the end, otherwise not.}
 \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{
  \code{\link[R.utils:timestampOn.Verbose]{*timestampOn}()} and \code{timestampOff}().
  For more information see \code{\link{Verbose}}.
}


\keyword{internal}
\keyword{methods}
\keyword{programming}