\HeaderA{strwrap}{Wrap Character Strings to Format Paragraphs}{strwrap}
\keyword{character}{strwrap}
\begin{Description}\relax
Each character string in the input is first split into paragraphs (on
lines containing whitespace only).  The paragraphs are then formatted
by breaking lines at word boundaries.  The target columns for wrapping
lines and the indentation of the first and all subsequent lines of a
paragraph can be controlled independently.
\end{Description}
\begin{Usage}
\begin{verbatim}
strwrap(x, width = 0.9 * getOption("width"), indent = 0,
        exdent = 0, prefix = "", simplify = TRUE)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{x}] a character vector, or an object which can be converted to a
character vector by \code{\LinkA{as.character}{as.character}}.
\item[\code{width}] a positive integer giving the target column for wrapping
lines in the output.
\item[\code{indent}] a non-negative integer giving the indentation of the
first line in a paragraph.
\item[\code{exdent}] a non-negative integer specifying the indentation of
subsequent lines in paragraphs.
\item[\code{prefix}] a character string to be used as prefix for each line.
\item[\code{simplify}] a logical.  If \code{TRUE}, the result is a single
character vector of line text; otherwise, it is a list of the same
length as \code{x} the elements of which are character vectors of
line text obtained from the corresponding element of \code{x}.
(Hence, the result in the former case is obtained by unlisting that
of the latter.)
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
Whitespace in the input is destroyed.  Double spaces after periods
(thought as representing sentence ends) are preserved.  Currently,
possible sentence ends at line breaks are not considered specially.

Indentation is relative to the number of characters in the prefix
string.
\end{Details}
\begin{Examples}
\begin{ExampleCode}
## Read in file 'THANKS'.
x <- paste(readLines(file.path(R.home("doc"), "THANKS")), collapse = "\n")
## Split into paragraphs and remove the first three ones
x <- unlist(strsplit(x, "\n[ \t\n]*\n"))[-(1:3)]
## Join the rest
x <- paste(x, collapse = "\n\n")
## Now for some fun:
writeLines(strwrap(x, width = 60))
writeLines(strwrap(x, width = 60, indent = 5))
writeLines(strwrap(x, width = 60, exdent = 5))
writeLines(strwrap(x, prefix = "THANKS> "))

## Note that messages are wrapped AT the target column indicated by
## 'width' (and not beyond it).
## From an R-devel posting by J. Hosking <jh910@juno.com>.
x <- paste(sapply(sample(10, 100, replace=TRUE),
           function(x) substring("aaaaaaaaaa", 1, x)), collapse = " ")
sapply(10:40,
       function(m)
       c(target = m, actual = max(nchar(strwrap(x, m)))))
\end{ExampleCode}
\end{Examples}

