rename to label_dictionary()

NAMESPACE

@@ -120,10 +120,10 @@ export(label_comma)
 export(label_currency)
 export(label_date)
 export(label_date_short)
+export(label_dictionary)
 export(label_dollar)
 export(label_glue)
 export(label_log)
-export(label_lut)
 export(label_math)
 export(label_number)
 export(label_number_auto)

NEWS.md

@@ -10,8 +10,7 @@
   using `get_palette()` or registered using `set_palette()` (#396).
 * `label_log()` has a `signed` argument for displaying negative numbers 
   (@teunbrand, #421).
-
-* New `label_lut()` for named lookup of labels (#458).
+* New `label_dictionary()` for named lookup of labels (#458).
 
 # scales 1.3.0
 

R/label-lut.R

@@ -1,13 +1,14 @@
 
 #' Labels from lookup tables
 #'
-#' Use `label_lut()` for looking up succinct breaks in a named character vector
-#' giving complete labels.
+#' Use `label_dictionary()` for looking up succinct breaks in a named character
+#' vector giving complete labels.
 #'
-#' @param lut A named character vector of labels. The names are expected to
-#'   match the breaks, and the values become the labels.
-#' @param nomatch A string to label breaks that do not match any name in `lut`.
-#'  When `NULL` (default), the breaks are not translated but are kept as-is.
+#' @param dictionary A named character vector of labels. The names are expected
+#'   to match the breaks, and the values become the labels.
+#' @param nomatch A string to label breaks that do not match any name in
+#'  `dictionary`. When `NULL` (default), the breaks are not translated but are
+#'  kept as-is.
 #'
 #' @return A labeller function that takes a character vector of breaks and
 #'   returns a character vector of labels.
@@ -22,15 +23,15 @@
 #' )
 #'
 #' # Typical usage
-#' demo_discrete(c("4", "r", "f"), labels = label_lut(lut))
+#' demo_discrete(c("4", "r", "f"), labels = label_dictionary(lut))
 #' # By default, extra values ('w') will remain as-is
-#' demo_discrete(c("4", "r", "f", "w"), labels = label_lut(lut))
+#' demo_discrete(c("4", "r", "f", "w"), labels = label_dictionary(lut))
 #' # Alternatively, you can relabel extra values
 #' demo_discrete(
 #'   c("4", "r", "f", "w"),
-#'   labels = label_lut(lut, nomatch = "unknown")
+#'   labels = label_dictionary(lut, nomatch = "unknown")
 #' )
-label_lut <- function(lut = character(), nomatch = NULL) {
+label_dictionary <- function(dictionary = character(), nomatch = NULL) {
 
   if (!is.character(lut)) {
     cli::cli_abort("The {.arg lut} argument must be a character vector.")

tests/testthat/test-label-lut.R

@@ -1,11 +1,11 @@
-test_that("label_lut gives correct answers", {
+test_that("label_dictionary gives correct answers", {
 
   short <- c("A", "B", "C")
   lut <- c("A" = "Apple", "C" = "Cherry", "D" = "Date")
 
-  expect_equal(label_lut(lut)(short), c("Apple", "B", "Cherry"))
+  expect_equal(label__dictionary(lut)(short), c("Apple", "B", "Cherry"))
   expect_equal(
-    label_lut(lut, nomatch = "Banana")(short),
+    label_dictionary(lut, nomatch = "Banana")(short),
     c("Apple", "Banana", "Cherry")
   )
 })