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 54 55 56 57 58 59 60 61 62 63
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/glue.R
\name{str_glue}
\alias{str_glue}
\alias{str_glue_data}
\title{Interpolation with glue}
\usage{
str_glue(..., .sep = "", .envir = parent.frame())
str_glue_data(.x, ..., .sep = "", .envir = parent.frame(), .na = "NA")
}
\arguments{
\item{...}{[\code{expressions}]\cr Unnamed arguments are taken to be expression
string(s) to format. Multiple inputs are concatenated together before formatting.
Named arguments are taken to be temporary variables available for substitution.}
\item{.sep}{[\code{character(1)}: \sQuote{""}]\cr Separator used to separate elements.}
\item{.envir}{[\code{environment}: \code{parent.frame()}]\cr Environment to evaluate each expression in. Expressions are
evaluated from left to right. If \code{.x} is an environment, the expressions are
evaluated in that environment and \code{.envir} is ignored. If \code{NULL} is passed, it is equivalent to \code{\link[=emptyenv]{emptyenv()}}.}
\item{.x}{[\code{listish}]\cr An environment, list, or data frame used to lookup values.}
\item{.na}{[\code{character(1)}: \sQuote{NA}]\cr Value to replace \code{NA} values
with. If \code{NULL} missing values are propagated, that is an \code{NA} result will
cause \code{NA} output. Otherwise the value is replaced by the value of \code{.na}.}
}
\value{
A character vector with same length as the longest input.
}
\description{
These functions are wrappers around \code{\link[glue:glue]{glue::glue()}} and \code{\link[glue:glue]{glue::glue_data()}},
which provide a powerful and elegant syntax for interpolating strings
with \code{{}}.
These wrappers provide a small set of the full options. Use \code{glue()} and
\code{glue_data()} directly from glue for more control.
}
\examples{
name <- "Fred"
age <- 50
anniversary <- as.Date("1991-10-12")
str_glue(
"My name is {name}, ",
"my age next year is {age + 1}, ",
"and my anniversary is {format(anniversary, '\%A, \%B \%d, \%Y')}."
)
# single braces can be inserted by doubling them
str_glue("My name is {name}, not {{name}}.")
# You can also used named arguments
str_glue(
"My name is {name}, ",
"and my age next year is {age + 1}.",
name = "Joe",
age = 40
)
# `str_glue_data()` is useful in data pipelines
mtcars \%>\% str_glue_data("{rownames(.)} has {hp} hp")
}
|