stri_flatten: Flatten a String

Description

Joins the elements of a character vector into one string.

Usage

stri_flatten(str, collapse = "", na_empty = FALSE, omit_empty = FALSE)

Arguments

str

a vector of strings to be coerced to character

collapse

a single string denoting the separator

na_empty

single logical value; should missing values in str be treated as empty strings (TRUE) or be omitted whatsoever (NA)?

omit_empty

single logical value; should empty strings in str be omitted?

Details

The stri_flatten(str, collapse='XXX') call is equivalent to paste(str, collapse='XXX', sep='').

If you wish to use some more fancy (e.g., differing) separators between flattened strings, call stri_join(str, separators, collapse='').

If str is not empty, then a single string is returned. If collapse has length > 1, then only the first string will be used.

Value

Returns a single string, i.e., a character vector of length 1.

Author(s)

Marek Gagolewski and other contributors

See Also

The official online manual of stringi at https://stringi.gagolewski.com/

Other join: %s+%(), stri_dup(), stri_join_list(), stri_join()

Examples

stri_flatten(LETTERS)
## [1] "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
stri_flatten(LETTERS, collapse=',')
## [1] "A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z"
stri_flatten(stri_dup(letters[1:6], 1:3))
## [1] "abbcccdeefff"
stri_flatten(c(NA, '', 'A', '', 'B', NA, 'C'), collapse=',', na_empty=TRUE, omit_empty=TRUE)
## [1] "A,B,C"
stri_flatten(c(NA, '', 'A', '', 'B', NA, 'C'), collapse=',', na_empty=NA)
## [1] ",A,,B,C"