Formatting Utilities
str_out formats character vectors for use in show methods or
error/warning messages.
str_out( x, max = 3L, quote = is.character(x), use.names = FALSE, sep = ", ", total = FALSE ) str_desc(object, exdent = 0L) str_fun(object) str_class(x, max = Inf, ...) str_pkg(pkg, lib.loc = NULL) str_md5sum(x) str_hash(x, algo = "md5") str_dim(x, dims = dim(x)) str_bs(x)
x |
character vector |
max |
maximum number of values to appear in the list. If |
quote |
a logical indicating whether the values should be quoted with single quotes (defaults) or not. |
use.names |
a logical indicating whether names should be added to the
list as |
sep |
separator character |
total |
logical that indicates if the total number of elements should be
appended to the formatted string as |
object |
an R object |
exdent |
extra indentation passed to str_wrap, and used if the output should spread over more than one lines. |
... |
other arguments passed to str_out. |
pkg |
package name |
lib.loc |
path to a library of R packages |
algo |
The algorithms to be used; currently available choices are
|
dims |
a numeric vector of dimensions.
Default is to use the input object dimensions (via function |
a single character string
str_desc: builds formatted string from a list of complex values.
str_fun: extracts and formats a function signature.
It typically formats the output capture.output(args(object)).
str_class: outputs the class(es) of an object using str_out.
str_pkg: formats a package name and version
str_md5sum: computes md5sum on character vector using md5sum.
str_hash: computes hash of a character vector using digest.
str_dim: builds a string that describes the dimension of an object, in the form
n x m for 2D-objects, n x m x p for 3D-objects, and so on.
str_bs: substitutes backspace characters (\\b) to produce
a character string as it would be displayed in the console.
Renaud Gaujoux
str_bs was adapted from a proposal from Yihui Xie.
x <- letters[1:10]
str_out(x)
str_out(x, 8)
str_out(x, Inf)
str_out(x, quote=FALSE)
str_out(x, total = TRUE)
str_fun(install.packages)
str_class(matrix())
# Backspace substitution
str_bs("abc")
str_bs("abc\b")
str_bs("abc\b\b")
str_bs("abc\bd")
str_bs("abc\b\bde\b")
# more complex example
x <- "\bab\nc\bd\n\babc\b\bd"
cat(x, "\n")
y <- str_bs(x)
y
cat(y, "\n")Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.