printBanner: Print a nice banner

Description Usage Arguments Details Value See Also Examples

View source: R/printBanner.R

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

1
printBanner(str, banner.width=options()$width, char.perline=.75*banner.width, border="=")

Arguments

str

character string - a title within the banner

banner.width

width of banner, the default is set to fit current options

char.perline

number of characters per line for the title, the default is 75% of the banner.width parameter

border

type of character for the border

Details

This function prints a nice banner in both R and S-PLUS

Value

nothing is returned

See Also

options

Examples

1
2
3
4
5
6
printBanner("This is a pretty banner", banner.width=40, char.perline=30)

# the output looks like this:
# ========================================
#         This is a pretty banner
# ========================================

Example output

Loading required package: Matrix
Loading required package: quadprog
======================================== 
        This is a pretty banner          
======================================== 

kinship2 documentation built on May 29, 2017, 3:49 p.m.