File: str_c.Rd

package info (click to toggle)
r-cran-stringr 0.6.2-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 308 kB
  • sloc: makefile: 3
file content (47 lines) | stat: -rw-r--r-- 1,386 bytes parent folder | download | duplicates (2)
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
\name{str_c}
\alias{str_c}
\alias{str_join}
\title{Join multiple strings into a single string.}
\usage{
  str_c(..., sep = "", collapse = NULL)
}
\arguments{
  \item{...}{one or more character vectors.  Zero length
  arguments are removed}

  \item{sep}{string to insert between input vectors}

  \item{collapse}{optional string used to combine input
  vectors into single string}
}
\value{
  If \code{collapse = NULL} (the default) a character
  vector with length equal to the longest input string.  If
  \code{collapse} is non- NULL, a character vector of
  length 1.
}
\description{
  To understand how \code{str_c} works, you need to imagine
  that you are building up a matrix of strings.  Each input
  argument forms a column, and is expanded to the length of
  the longest argument, using the usual recyling rules.
  The \code{sep} string is inserted between each column. If
  collapse is \code{NULL} each row is collapsed into a
  single string.  If non-\code{NULL} that string is
  inserted at the end of each row, and the entire matrix
  collapsed to a single string.
}
\examples{
str_c("Letter: ", letters)
str_c("Letter", letters, sep = ": ")
str_c(letters, " is for", "...")
str_c(letters[-26], " comes before ", letters[-1])

str_c(letters, collapse = "")
str_c(letters, collapse = ", ")
}
\seealso{
  \code{\link{paste}} which this function wraps
}
\keyword{character}