help_create_break: create a break sequence

View source: R/insert_breaks.R

help_create_breakR Documentation

create a break sequence

Description

the idea of the helper function is to return a string of a line length that is composed of the start character and the break_characters

Usage

help_create_break(start = "##", sep = " ", break_char = "-",
  length = options()$strcode$char_length, anchor_in_sep = FALSE)

Arguments

start

A sequence of letters to start the sequence.

sep

A separator sequence to separate start and break_char.

break_char

A character (sequence) used to create the actual break.

length

An integer value indicating how long the sequence should be.

anchor_in_sep

whether or not a code anchor (that is, a hash) should be inserted in the center of the separator.


lorenzwalthert/strcode documentation built on May 11, 2023, 12:10 a.m.