strtrim_ctl {fansi} | R Documentation |
One difference with base::strtrim is that all C0 control characters such as newlines, carriage returns, etc., are treated as zero width.
strtrim_ctl(x, width, warn = getOption("fansi.warn")) strtrim2_ctl(x, width, warn = getOption("fansi.warn"), tabs.as.spaces = getOption("fansi.tabs.as.spaces"), tab.stops = getOption("fansi.tab.stops"))
x |
a character vector, or an object which can be coerced to a
character vector by |
width |
Positive integer values: recycled to the length of |
warn |
TRUE (default) or FALSE, whether to warn when potentially
problematic Control Sequences are encountered. These could cause the
assumptions |
tabs.as.spaces |
FALSE (default) or TRUE, whether to convert tabs to
spaces. This can only be set to TRUE if |
tab.stops |
integer(1:n) indicating position of tab stops to use when converting tabs to spaces. If there are more tabs in a line than defined tab stops the last tab stop is re-used. For the purposes of applying tab stops, each input line is considered a line and the character count begins from the beginning of the input line. |
strtrim2_ctl
adds the option of converting tabs to spaces before trimming.
This is the only difference between strtrim_ctl
and strtrim2_ctl
.
Non-ASCII strings are converted to and returned in UTF-8 encoding. Width calculations will not work correctly with R < 3.2.2.
fansi for details on how Control Sequences are interpreted, particularly if you are getting unexpected results. strwrap_ctl is used internally by this function.
strtrim_ctl("\033[42mHello world\033[m", 6)