1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
|
\name{str_wrap}
\alias{str_wrap}
\title{Wrap strings into nicely formatted paragraphs.}
\usage{
str_wrap(string, width = 80, indent = 0, exdent = 0)
}
\arguments{
\item{string}{character vector of strings to reformat.}
\item{width}{positive integer giving target line width in
characters.}
\item{indent}{non-negative integer giving indentation of
first line in each paragraph}
\item{exdent}{non-negative integer giving indentation of
following lines in each paragraph}
}
\value{
a character vector of reformatted strings.
}
\description{
This is currently implemented as thin wrapper over
\code{\link{strwrap}}, but is vectorised over
\code{stringr}, and collapses output into single strings.
See \code{\link{strwrap}} for more details.
}
\examples{
thanks <- str_c(readLines(R.home("doc/THANKS")), collapse = "\\n")
thanks <- word(thanks, 1, 3, fixed("\\n\\n"))
cat(str_wrap(thanks), "\\n")
cat(str_wrap(thanks, width = 40), "\\n")
cat(str_wrap(thanks, width = 60, indent = 2), "\\n")
cat(str_wrap(thanks, width = 60, exdent = 2), "\\n")
}
|