File: header.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,342 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{header.Verbose}
\alias{header.Verbose}
\alias{Verbose.header}
\alias{header,Verbose-method}

\title{Writes a header}

\description{
  Writes a header surrounded by a frame.
  The output is indented according to \code{\link[R.utils:enter.Verbose]{*enter}()}/\code{\link[R.utils:exit.Verbose]{*exit}()}
  calls.
}

\usage{
\method{header}{Verbose}(this, ..., char="-", padding=0, prefix=paste(char, paste(rep(" ",
  max(padding, 1)), collapse = ""), sep = ""), level=this$defaultLevel)
}

\arguments{
 \item{...}{The title.}
 \item{char}{The \code{\link[base]{character}} string to make up the frame.}
 \item{padding}{The number of rows and character to pad the title above,
                below, and to the left.}
 \item{prefix}{The prefix of all padded lines and the title line.}
 \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}