pioStr: Print a string 'A = ...'.

In caravagn/pio: pio - Pretty I/O

Description

This function prints a string 'A = ...'. thought to represent a description 'A' followed by one or more values '...'.

For instance 'P-value = 0.05' can be print by passing the string '"P-value ="' together with '0.05'.

The function colours the first of the two parameters via options 'pio.string_bg_colour' and 'pio.string_fg_colour', and the second string according to the tokenizer function pioTkn.

The function can also add a prefix and a suffix to the output, which allows easily to indent the output message, or add a newline at the end of it.

Usage

pioStr(str, ..., suffix = "", prefix = "")

Arguments

str	First string to print, the description that is to be coloured.
...	A list of parameters that will be concatenated to create the second, non coloured, value. These will be tokenized with pioTkn.
suffix	Suffix to add as tail of the string.
prefix	Suffix to add as head of the string.

Value

None

Examples

pioStr("My string", 12345)
pioStr("My variable", TRUE, 'for some reason')

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