form3title: prints or prepares a title

Description Usage Arguments Value Examples

View source: R/rbsa1.code.r

Description

prints or prepares the character string tit with more or less emphasis. This function is a shortcut of the hidden function form3titre, with some specialized calls.

Usage

1
2
 
  form3title(tit,empha=3,indent=2+2*empha,imp=TRUE) 

Arguments

tit

the title to print (just one line)

empha

Level of emphasizing.
(0): single line without carriage return
(1): single line
(2): underlined
(3): underlined and overlined
(4): (2) + 1 line before
(5): (3) + 1 line after
(6): (2) + 2 lines before and after
(7): corners + 1 line before and after (plus surrounding)
(8): box + 1 lines before and after (plus surrounding)

indent

Number of spaces to introduce before the title

imp

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

Value

either nothing or a character string according to imp

Examples

1
2
 
  for (ii in 0:8) {form3title("Some Title",ii,imp=TRUE)}; 

rbsa documentation built on May 31, 2017, 4:29 a.m.