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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
% $Author: sinnwell $
% $Date: 2008/05/09 15:03:01 $
% $Header: /people/biostat3/sinnwell/Haplo/Make/RCS/printBanner.Rd,v 1.3 2008/05/09 15:03:01 sinnwell Exp $
% $Id: printBanner.Rd,v 1.3 2008/05/09 15:03:01 sinnwell Exp $
% $Locker: $
% $Log: printBanner.Rd,v $
% Revision 1.3 2008/05/09 15:03:01 sinnwell
% add to description
%
% Revision 1.2 2008/01/08 20:29:41 sinnwell
% fix comments
%
% Revision 1.1 2008/01/08 18:26:06 sinnwell
% Initial revision
%
%Revision 1.4 2007/12/21 17:21:07 sinnwell
%add description
%
%Revision 1.3 2005/02/04 20:57:46 sinnwell
%banner.width and char.perline comply to options()$width
%
%Revision 1.2 2004/06/29 19:54:56 sinnwell
%now works in both R and Splus
%
%Revision 1.1 2004/02/26 21:35:08 sinnwell
%Initial revision
%
%Revision 1.2 2003/01/20 23:21:06 sinnwell
%fixed RCS keywords
\name{printBanner}
\alias{printBanner}
\title{
Print a nice banner
}
\description{
Print a nice banner with a border above and below the text. It centers
the text, and adjusts to the width system option by breaking into
multiple lines when needed.
}
\usage{
printBanner(str, banner.width=options()$width, char.perline=.75*banner.width, border="=")
}
\arguments{
\item{str}{
character string - a title within the banner
}
\item{banner.width }{
width of banner, the default is set to fit current options
}
\item{char.perline }{
number of characters per line for the title, the default is 75\% of
the banner.width parameter
}
\item{border}{
type of character for the border
}
}
\value{
}
\section{Side Effects}{
}
\details{
This function prints a nice banner in both R and S-PLUS
}
\section{References}{
}
\seealso{
options
}
\examples{
printBanner("This is a pretty banner", banner.width=40, char.perline=30)
# the output looks like this:
# ========================================
# This is a pretty banner
# ========================================
}
\keyword{}
% docclass is function
% Converted by Sd2Rd version 37351.
|
