mlr3misc (version 0.3.0)

str_indent: Indent Strings

Description

Formats a text block for printing.

Usage

str_indent(initial, str, width = 0.9 * getOption("width"), exdent = 2L, ...)

Arguments

initial

(character(1)) Initial string, passed to strwrap().

str

(character()) Vector of strings.

width

(integer(1)) Width of the output.

exdent

(integer(1)) Indentation of subsequent lines in paragraph.

...

(any) Additional parameters passed to str_collapse().

Value

(character()).

Examples

# NOT RUN {
cat(str_indent("Letters:", str_collapse(letters), width = 25), sep = "\n")
# }