wordwrap: Wrap or break strings into lines of specified width

In datapplab/pathview: a tool set for pathway based data integration and visualization

Wrap or break strings into lines of specified width

Description

strfit does hard wrapping, i.e. break within long words, wordwrap is a wrapper of strfit but also provides soft wrapping option, i.e. break only between words, and keep long words intact.

Usage

wordwrap(s, width = 20, break.word = FALSE)
strfit(s, width = 20)

Arguments

s	characcter, strings to be wrapped or broken down.
width	integer, target line width in terms of number of characters. d width=20.
break.word	logical, whether to break within words or only between words as to fit the line width. Default break.word=FALSE, i.e. keep words intact and only break between words. Therefore, some line may exceed the width limit.

Details

These functions are called as to wrap long node labels into shorter lines on pathway graphs in keggview.graph function (when keggview.native=FALSE). They are equally useful for wrapping long labels in other types of graphs or output formats.

Value

character of the same length of s except that each element has been wrapped softly or hardly.

Author(s)

Weijun Luo <[e-mail]>

References

Luo, W. and Brouwer, C., Pathview: an R/Bioconductor package for pathway based data integration and visualization. Bioinformatics, 2013, 29(14): 1830-1831, doi: 10.1093/bioinformatics/btt285

See Also

strwrap in R base.

Examples

long.str="(S)-Methylmalonate semialdehyde"
wr1=wordwrap(long.str, width=15)
#long word intact
cat(wr1, sep="\n")
wr2=strfit(long.str, width=15)
#long word split
cat(wr2, sep="\n")

datapplab/pathview documentation built on March 30, 2024, 9:06 a.m.