Skip to contents

Format text as a simple comment header

Source: R/utils.R
comment_header.Rd

Formats text as a simple single-line comment header.

Usage

comment_header(text, char = "-", width = 80L)

Arguments

text

Character string to format.

char

Character to use for decoration. Default "-".

width

Total width of the header. Default 80.

Value

Character string formatted as a comment header.

Examples

cat(comment_header("Load Libraries"))
#> # Load Libraries ---------------------------------------------------------------
# # Load Libraries --------------------------------------------------------