1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/flatten.R
\name{str_flatten}
\alias{str_flatten}
\alias{str_flatten_comma}
\title{Flatten a string}
\usage{
str_flatten(string, collapse = "", last = NULL, na.rm = FALSE)
str_flatten_comma(string, last = NULL, na.rm = FALSE)
}
\arguments{
\item{string}{Input vector. Either a character vector, or something
coercible to one.}
\item{collapse}{String to insert between each piece. Defaults to \code{""}.}
\item{last}{Optional string to use in place of the final separator.}
\item{na.rm}{Remove missing values? If \code{FALSE} (the default), the result
will be \code{NA} if any element of \code{string} is \code{NA}.}
}
\value{
A string, i.e. a character vector of length 1.
}
\description{
\code{str_flatten()} reduces a character vector to a single string. This is a
summary function because regardless of the length of the input \code{x}, it
always returns a single string.
\code{str_flatten_comma()} is a variation designed specifically for flattening
with commas. It automatically recognises if \code{last} uses the Oxford comma
and handles the special case of 2 elements.
}
\examples{
str_flatten(letters)
str_flatten(letters, "-")
str_flatten(letters[1:3], ", ")
# Use last to customise the last component
str_flatten(letters[1:3], ", ", " and ")
# this almost works if you want an Oxford (aka serial) comma
str_flatten(letters[1:3], ", ", ", and ")
# but it will always add a comma, even when not necessary
str_flatten(letters[1:2], ", ", ", and ")
# str_flatten_comma knows how to handle the Oxford comma
str_flatten_comma(letters[1:3], ", and ")
str_flatten_comma(letters[1:2], ", and ")
}
|
