bookend_line: Internal function for formatting a line with characters on...

Description Usage Arguments Value Examples

View source: R/bookend_line.R

Description

Internal function for formatting a line with characters on left and right sides.

Usage

1
bookend_line(x, linewidth = 80, type = c("basic", "roxygen2"))

Arguments

x

character string.

linewidth

Intended maximum number of characters per line.

type

Two options:

  • basic: Simple format with # box at the beginning.

  • roxygen2: Format consistent with package builder roxygen2.

Value

Character string of length 80.

Examples

1
2
bookend_line("abcde",linewidth = 10,type = "basic")
bookend_line("abcde",linewidth = 10,type = "roxygen2")

danwkenn/ConsulR documentation built on Dec. 19, 2021, 8:11 p.m.