rename mapping to class_mapping

Author: teunbrand

NAMESPACE

@@ -292,6 +292,7 @@ export(binned_scale)
 export(borders)
 export(calc_element)
 export(check_device)
+export(class_mapping)
 export(combine_vars)
 export(complete_theme)
 export(continuous_scale)

R/aes.R

@@ -105,10 +105,20 @@ aes <- function(x, y, ...) {
     inject(aes(!!!args))
   })
 
-  mapping(rename_aes(args), env = parent.frame())
+  class_mapping(rename_aes(args), env = parent.frame())
 }
 
-mapping <- S7::new_class(
+#' The mapping class
+#'
+#' The mapping class holds a list of quoted expressions
+#' ([quosures][rlang::topic-quosure]) or constants. An object is typically
+#' constructed using the [`aes()`] function.
+#'
+#' @param x A list of quosures and constants.
+#' @param env An environment for symbols that are not quosures or constants.
+#'
+#' @export
+class_mapping <- S7::new_class(
   "mapping", parent = S7::new_S3_class("gg"),
   constructor = function(x, env = globalenv()) {
     check_object(x, is.list, "a {.cls list}")
@@ -119,7 +129,7 @@ mapping <- S7::new_class(
 
 #' @export
 #' @rdname is_tests
-is.mapping <- function(x) S7::S7_inherits(x, mapping)
+is.mapping <- function(x) S7::S7_inherits(x, class_mapping)
 
 # Wrap symbolic objects in quosures but pull out constants out of
 # quosures for backward-compatibility
@@ -157,21 +167,21 @@ new_aesthetic <- function(x, env = globalenv()) {
 
 #' @export
 "[.ggplot2::mapping" <- function(x, i, ...) {
-  mapping(NextMethod())
+  class_mapping(NextMethod())
 }
 
 # If necessary coerce replacements to quosures for compatibility
 #' @export
 "[[<-.ggplot2::mapping" <- function(x, i, value) {
-  mapping(NextMethod())
+  class_mapping(NextMethod())
 }
 #' @export
 "$<-.ggplot2::mapping" <- function(x, i, value) {
-  mapping(NextMethod())
+  class_mapping(NextMethod())
 }
 #' @export
 "[<-.ggplot2::mapping" <- function(x, i, value) {
-  mapping(NextMethod())
+  class_mapping(NextMethod())
 }
 
 #' Standardise aesthetic names
@@ -212,7 +222,7 @@ substitute_aes <- function(x, fun = standardise_aes_symbols, ...) {
   x <- lapply(x, function(aesthetic) {
     as_quosure(fun(quo_get_expr(aesthetic), ...), env = environment(aesthetic))
   })
-  mapping(x)
+  class_mapping(x)
 }
 # x is a quoted expression from inside aes()
 standardise_aes_symbols <- function(x) {
@@ -310,7 +320,7 @@ aes_ <- function(x, y, ...) {
     }
   }
   mapping <- lapply(mapping, as_quosure_aes)
-  mapping(rename_aes(mapping))
+  class_mapping(rename_aes(mapping))
 }
 
 #' @rdname aes_
@@ -336,7 +346,7 @@ aes_string <- function(x, y, ...) {
     new_aesthetic(x, env = caller_env)
   })
 
-  mapping(rename_aes(mapping))
+  class_mapping(rename_aes(mapping))
 }
 
 #' @export
@@ -357,7 +367,7 @@ aes_all <- function(vars) {
 
   # Quosure the symbols in the empty environment because they can only
   # refer to the data mask
-  mapping(lapply(vars, function(x) new_quosure(as.name(x), emptyenv())))
+  class_mapping(lapply(vars, function(x) new_quosure(as.name(x), emptyenv())))
 }
 
 #' Automatic aesthetic mapping
@@ -392,7 +402,7 @@ aes_auto <- function(data = NULL, ...) {
     aes <- c(aes, args[names(args) != "data"])
   }
 
-  mapping(rename_aes(aes))
+  class_mapping(rename_aes(aes))
 }
 
 mapped_aesthetics <- function(x) {

R/layer.R

@@ -213,7 +213,7 @@ validate_mapping <- function(mapping, call = caller_env()) {
   }
 
   # For backward compatibility with pre-tidy-eval layers
-  mapping(mapping)
+  class_mapping(mapping)
 }
 
 Layer <- ggproto("Layer", NULL,
@@ -265,7 +265,7 @@ Layer <- ggproto("Layer", NULL,
   setup_layer = function(self, data, plot) {
     # For annotation geoms, it is useful to be able to ignore the default aes
     if (isTRUE(self$inherit.aes)) {
-      self$computed_mapping <- mapping(defaults(self$mapping, plot@mapping))
+      self$computed_mapping <- class_mapping(defaults(self$mapping, plot@mapping))
 
       # Inherit size as linewidth from global mapping
       if (self$geom$rename_size &&

R/plot-construction.R

@@ -156,9 +156,9 @@ S7::method(ggplot_add, list(class_guides, class_ggplot)) <-
     plot
   }
 
-S7::method(ggplot_add, list(mapping, class_ggplot)) <-
+S7::method(ggplot_add, list(class_mapping, class_ggplot)) <-
   function(object, plot, ...) {
-    S7::set_props(plot, mapping = mapping(defaults(object, plot@mapping)))
+    S7::set_props(plot, mapping = class_mapping(defaults(object, plot@mapping)))
   }
 
 S7::method(ggplot_add, list(theme, class_ggplot)) <-

R/plot.R

@@ -8,7 +8,7 @@ class_ggplot <- S7::new_class(
     layers  = S7::class_list,
     scales  = class_scales_list,
     guides  = class_guides,
-    mapping = mapping,
+    mapping = class_mapping,
     theme   = theme,
     coordinates = class_coord,
     facet   = class_facet,

R/quick-plot.R

@@ -78,7 +78,7 @@ qplot <- function(x, y, ..., data, facets = NULL, margins = FALSE,
   is_constant <- (!names(exprs) %in% ggplot_global$all_aesthetics) |
     vapply(exprs, quo_is_call, logical(1), name = "I")
 
-  mapping <- mapping(exprs[!is_missing & !is_constant], env = parent.frame())
+  mapping <- class_mapping(exprs[!is_missing & !is_constant], env = parent.frame())
 
   consts <- exprs[is_constant]
 

man/class_mapping.Rd

@@ -54,7 +54,7 @@
 
     Don't know how to get alternative usage for `foo`.
 
-# mapping() checks its inputs
+# class_mapping() checks its inputs
 
     `x` must be a <list>, not an integer vector.
 

tests/testthat/_snaps/aes.md

@@ -1,4 +1,4 @@
 test_that("mapping class is preserved when adding mapping objects", {
   p <- ggplot(mtcars) + aes(wt, mpg)
-  expect_s7_class(p@mapping, mapping)
+  expect_s7_class(p@mapping, class_mapping)
 })

tests/testthat/test-add.R

@@ -195,8 +195,8 @@ test_that("alternative_aes_extract_usage() can inspect the call", {
   expect_snapshot_error(alternative_aes_extract_usage(x))
 })
 
-test_that("mapping() checks its inputs", {
-  expect_snapshot_error(mapping(1:5))
+test_that("class_mapping() checks its inputs", {
+  expect_snapshot_error(class_mapping(1:5))
 })
 
 # Visual tests ------------------------------------------------------------