revtools (version 0.4.1)

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, html = FALSE)

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 number of characters that should separate consecutive line breaks.

html

Logical: Should the function add HTML line breaks (<br>)? Defaults to FALSE, in which case the newline sequence is used instead (escape-n).

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 acutally a threshold value rather than being matched exactly.

Examples

# NOT RUN {
file_location <- system.file(
  "extdata",
  "avian_ecology_bibliography.ris",
  package = "revtools")
x <- read_bibliography(file_location)
add_line_breaks(x$title)
# }