synthesisr (version 0.3.0)

add_line_breaks: Add line breaks to one or more strings

Description

This function takes a vector of strings and adds line breaks every n characters. Primarily built to be called internally by format_citation, this function has been made available as it can be useful in other contexts.

Usage

add_line_breaks(x, n = 50, max_n = 80, html = FALSE, max_time = 60)

Arguments

x

Either a string or a vector; if the vector is not of class character if will be coerced to one using as.character.

n

Numeric: The desired number of characters that should separate consecutive line breaks.

max_n

Numeric: The maximum number of characters that may separate consecutive line breaks.

html

logical: Should the line breaks be specified in html?

max_time

Numeric: What is the maximum amount of time (in seconds) allowed to adjust groups until character thresholds are reached?

Value

Returns the input vector unaltered except for the addition of line breaks.

Details

Line breaks are only added between words, so the value of n is actually a threshold value rather than being matched exactly. max_n is matched exactly if a limit is set and max_time is not reached finding new break points between words.

Examples

# NOT RUN {
add_line_breaks(c("On the Origin of Species"), n = 10)
# }