R: Truncate Strings and Add Ellipses If a String is Truncated.

StrTrunc {DescTools} | R Documentation

## Truncate Strings and Add Ellipses If a String is Truncated.

### Description

Truncates one or more strings to a specified length, adding an ellipsis (...) to those strings that have been truncated. Use `formatC` to justify the strings if needed.

### Usage

     StrTrunc(x, maxlen = 20)

### Arguments

`x` | a vector of strings.
`maxlen` | the maximum length of the returned strings.

### Value

The string(s) passed as x now with a maximum length of maxlen + 3 (for the ellipsis).

### Author(s)

Andri Signorell,
following an idea of Jim Lemon in `truncString()`

### See Also

String functions: `nchar`, `match`, `grep`, `regexpr`, `substr`, `sub`, `gsub`, `StrTrim`, `StrDist`

### Examples

    set.seed(1789)
    x <- sapply(seq(10),  function(x) paste(sample(letters, sample(20,1)),collapse=""))
    x

    StrTrunc(x, maxlen=10)

    # right justification
    formatC(StrTrunc(x, maxlen=10), width = 10, flag=" ")

[Package DescTools version 0.99.26 Index]