pioTit: Print a title.

In caravagn/pio: pio - Pretty I/O

Description

Print a title to screen, surrounded by lines created from a separator (e.g., '=-'). A title has a newline both before and after the title is print.

Usage

pioTit(..., prefix = "", separator_motif = "=-")

Arguments

...	A list of parameters that will be concatenated to create the title.
prefix	A prefix to the string and dashes (e.g. some indentation char like '\t'), nothing by default.
separator_motif	The separator motif, default is '=-'.

Value

None

Examples

pioTit('We now perform some long computation') # A title can be a long string

# Can contain variables
x = 12345
y = "myFun"
pioTit('We now call', y, 'with', x, "as inoput")

# A title can be indented
pioTit('To the right', prefix = '\t')

# Or even have more complex layouts
pioTit('To the right', prefix = '>--\\/\\/\\/-->>')

# The separator can be customized
pioTit('We now perform some long computation', separator_motif = '|-=__=-|')

caravagn/pio documentation built on June 21, 2020, 5:18 a.m.