form3title: prints or prepares a title

Description Usage Arguments Value Examples

View source: R/f0.rbsb1.code.r

Description

prints or prepares the character string tit (can comprise several components) with more or less emphasis.

Usage

1
2
3
form3title(tit, box="un", lbef=0, sbef=5, saft=0, laft=1, charbox=c("+", "|",
	  "+", "-", "+", "|", "+", "-", "."), alig=2, caret=TRUE,
	  imp=TRUE)

Arguments

tit

the title to print, each component will be printed in a different line.

box

defines the type of box to put around the title. Possible options are:
"no" for nothing,
"un" for underlined,
"ov" for overlined,
"par" for parentherized,
"cor" for the four corners,
"unov" for underlined and overlined,
"box" for a complete box.

lbef

if numeric(1) defines the number of empty lines before the title; when character provides the lines to add before the title.

sbef

either numeric(1) or character(1) indicating the number of spaces or the characters to introduce before the box.

saft

same as sbef but after.

laft

same as lbef but after.

charbox

nine single characters to define the box starting after noon, and the extra 9th beign the filling character for multiple line titles.

alig

The aligment to be done by form3justifie: 1 for left,2 for center and 3 for right.

caret

Indicates if \n must be added at the end of each created line.

imp

Printing is performed and nothing is returned. If FALSE, the character string is returned (including possible new lines)

Value

According to imp: nothing when printing is performed, a character string

Examples

1
2
3
4
5
6
7
 rbsb3k("RESET"); # needed only for R checking, to be forgotten
 form3title("Some Title");
 form3title(c("The title", "can comprise", "several lines"), 
 box="box", lbef=4, laft=2);
 form3title(c("The title", "can comprise", "several lines"), 
 box="box", lbef=4, laft=2, 
 charbox=c("*", "+", "/", "=", "*", "+", "/", "=", " "));

rbsb documentation built on May 31, 2017, 1:45 a.m.