File: enter.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 (56 lines) | stat: -rw-r--r-- 1,730 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:
% 
%  Verbose.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{enter.Verbose}
\alias{enter.Verbose}
\alias{Verbose.enter}
\alias{enter,Verbose-method}
\alias{Verbose.enterf}
\alias{enterf.Verbose}
\alias{enterf,Verbose-method}


\title{Writes a message and indents the following output}

\description{
  Writes a message and indents the following output.
  The output is indented according to \code{\link[R.utils:enter.Verbose]{*enter}()}/\code{\link[R.utils:exit.Verbose]{*exit}()}
  calls.
}

\usage{
  \method{enter}{Verbose}(this, ..., indent=this$indentStep, sep="", suffix="...", level=this$defaultLevel)
  \method{enterf}{Verbose}(this, fmtstr, ..., indent=this$indentStep, sep="", suffix="...",
  level=this$defaultLevel)
}

\arguments{
 \item{fmtstr}{An \code{\link[base]{sprintf}}() format string, which together with
   \code{...} constructs the message.}
 \item{...}{Objects to be passed to \code{\link[R.utils:cat.Verbose]{*cat}()}
            (or \code{\link[base]{sprintf}}()).}
 \item{indent}{The number of characters to add to the indentation.}
 \item{sep}{The default separator \code{\link[base]{character}} string.}
 \item{suffix}{A \code{\link[base]{character}} string to be appended to the end of the message.}
 \item{level}{A \code{\link[base]{numeric}} value to be compared to the threshold.}
}

\value{
  Returns nothing.
}

\author{Henrik Bengtsson}

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


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