document

r-lib · Oct 7, 2024 · 0a94bcc · 0a94bcc
1 parent 29402b4
commit 0a94bcc
Show file tree

Hide file tree

Showing 14 changed files with 96 additions and 2 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -39,4 +39,4 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 LazyLoad: yes
 Roxygen: list(markdown = TRUE, r6 = FALSE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
diff --git a/NAMESPACE b/NAMESPACE
@@ -116,6 +116,7 @@ export(label_currency)
 export(label_date)
 export(label_date_short)
 export(label_dollar)
+export(label_glue)
 export(label_log)
 export(label_math)
 export(label_number)

diff --git a/R/label-glue.R b/R/label-glue.R
@@ -1,4 +1,30 @@
-
+#' Interpolated labels
+#'
+#' Use `label_glue()` to perform string interpolation using the \pkg{glue}
+#' package. Enclosed expressions will be evaluated as R code.
+#'
+#' @param pattern A glue string used for formatting. The `x` variable holds the
+#'   breaks, so that `"{x}"` (default) returns the breaks as-is.
+#' @param ... Arguments passed on to [`glue::glue()`].
+#' @inheritParams glue::glue
+#'
+#' @return A labeller function that takes a vector of breaks and returns a
+#'   character vector of labels.
+#' @export
+#' @family labels for continuous scales
+#' @family labels for discrete scales
+#'
+#' @examples
+#' # Example variables
+#' animal  <- "penguin"
+#' species <- c("Adelie",  "Chinstrap", "Emperor", "Gentoo")
+#'
+#' # Typical use, note that {x} will become the breaks
+#' demo_discrete(species, labels = label_glue("The {x}\n{animal}"))
+#' # It adapts to the breaks that are present
+#' demo_discrete(species[-3], labels =  label_glue("The {x}\n{animal}"))
+#' # Contrary to directly glueing species + animal, which results in mislabelling!
+#' demo_discrete(species[-3], labels = glue::glue("The {species}\n{animal}"))
 label_glue <- function(pattern = "{x}", ..., .envir = caller_env()) {
   args <- list2(...)
   force_all(pattern, .envir)

diff --git a/man/label_bytes.Rd b/man/label_bytes.Rd
diff --git a/man/label_currency.Rd b/man/label_currency.Rd
diff --git a/man/label_glue.Rd b/man/label_glue.Rd
diff --git a/man/label_number_auto.Rd b/man/label_number_auto.Rd
diff --git a/man/label_number_si.Rd b/man/label_number_si.Rd
diff --git a/man/label_ordinal.Rd b/man/label_ordinal.Rd
diff --git a/man/label_parse.Rd b/man/label_parse.Rd
diff --git a/man/label_percent.Rd b/man/label_percent.Rd
diff --git a/man/label_pvalue.Rd b/man/label_pvalue.Rd
diff --git a/man/label_scientific.Rd b/man/label_scientific.Rd
diff --git a/man/label_wrap.Rd b/man/label_wrap.Rd