Rename to stat_density_2d and geom_density_2d.

Fixes #1426

Author: hadley

NAMESPACE

@@ -271,6 +271,7 @@ export(geom_crossbar)
 export(geom_curve)
 export(geom_density)
 export(geom_density2d)
+export(geom_density_2d)
 export(geom_dotplot)
 export(geom_errorbar)
 export(geom_errorbarh)
@@ -432,6 +433,7 @@ export(stat_contour)
 export(stat_count)
 export(stat_density)
 export(stat_density2d)
+export(stat_density_2d)
 export(stat_ecdf)
 export(stat_ellipse)
 export(stat_function)

NEWS.md

@@ -121,7 +121,8 @@ A number of geoms have been renamed to be internally consistent:
 
 * `stat_binhex()` and `stat_bin2d()` have been renamed to `stat_bin_hex()` 
   and `stat_bin_2d()` (#1274). `stat_summary2d()` has been renamed to 
-  `stat_summary_2d()`
+  `stat_summary_2d()`, `geom_density2d()`/`stat_density2d()` has been renamed 
+  to `geom_density_2d()`/`stat_density_2d()`.
 
 * `stat_spoke()` is now `geom_spoke()` since I realised it's a
   reparameterisation of `geom_segment().

R/geom-contour.r

@@ -5,7 +5,7 @@
 #'
 #' @inheritParams geom_point
 #' @inheritParams geom_path
-#' @seealso \code{\link{geom_density2d}}: 2d density contours
+#' @seealso \code{\link{geom_density_2d}}: 2d density contours
 #' @export
 #' @export
 #' @examples
@@ -15,7 +15,7 @@
 #'
 #' # Or compute from raw data
 #' ggplot(faithful, aes(waiting, eruptions)) +
-#'   geom_density2d()
+#'   geom_density_2d()
 #'
 #' \donttest{
 #' # Setting bins creates evenly spaced contours in the range of the data

R/geom-density2d.r

@@ -4,12 +4,12 @@
 #' results with contours. This can be useful for dealing with overplotting.
 #'
 #' @section Aesthetics:
-#' \Sexpr[results=rd,stage=build]{ggplot2:::rd_aesthetics("geom", "density2d")}
+#' \Sexpr[results=rd,stage=build]{ggplot2:::rd_aesthetics("geom", "density_2d")}
 #'
 #' @seealso \code{\link{geom_contour}} for contour drawing geom,
 #'  \code{\link{stat_sum}} for another way of dealing with overplotting
 #' @param geom,stat Use to override the default connection between
-#'   \code{geom_density2d} and \code{stat_density2d}.
+#'   \code{geom_density_2d} and \code{stat_density_2d}.
 #' @inheritParams geom_point
 #' @inheritParams geom_path
 #' @export
@@ -18,23 +18,23 @@
 #'  geom_point() +
 #'  xlim(0.5, 6) +
 #'  ylim(40, 110)
-#' m + geom_density2d()
+#' m + geom_density_2d()
 #' \donttest{
-#' m + stat_density2d(aes(fill = ..level..), geom = "polygon")
+#' m + stat_density_2d(aes(fill = ..level..), geom = "polygon")
 #'
-#' # If you map an aesthetic to a categorical variable, you will get a
-#' # set of contours for each value of that variable
 #' set.seed(4393)
 #' dsmall <- diamonds[sample(nrow(diamonds), 1000), ]
-#' d <- ggplot(dsmall, aes(x, y)) + geom_density2d(aes(colour = cut))
-#' d
+#' d <- ggplot(dsmall, aes(x, y))
+#' # If you map an aesthetic to a categorical variable, you will get a
+#' # set of contours for each value of that variable
+#' d + geom_density_2d(aes(colour = cut))
 #'
 #' # If we turn contouring off, we can use use geoms like tiles:
-#' d + stat_density2d(geom = "raster", aes(fill = ..density..), contour = FALSE)
+#' d + stat_density_2d(geom = "raster", aes(fill = ..density..), contour = FALSE)
 #' # Or points:
-#' d + stat_density2d(geom = "point", aes(size = ..density..), n = 20, contour = FALSE)
+#' d + stat_density_2d(geom = "point", aes(size = ..density..), n = 20, contour = FALSE)
 #' }
-geom_density2d <- function(mapping = NULL, data = NULL, stat = "density2d",
+geom_density_2d <- function(mapping = NULL, data = NULL, stat = "density2d",
                            position = "identity", lineend = "butt",
                            linejoin = "round", linemitre = 1,
                            na.rm = FALSE, show.legend = NA, inherit.aes = TRUE,
@@ -57,6 +57,11 @@ geom_density2d <- function(mapping = NULL, data = NULL, stat = "density2d",
   )
 }
 
+#' @export
+#' @rdname geom_density_2d
+#' @usage NULL
+geom_density2d <- geom_density_2d
+
 
 #' @rdname ggplot2-ggproto
 #' @format NULL

R/geom-point.r

@@ -16,8 +16,8 @@
 #' another. This can severely distort the visual appearance of the plot.
 #' There is no one solution to this problem, but there are some techniques
 #' that can help.  You can add additional information with
-#' \code{\link{stat_smooth}}, \code{\link{stat_quantile}} or
-#' \code{\link{stat_density2d}}.  If you have few unique x values,
+#' \code{\link{geom_smooth}}, \code{\link{geom_quantile}} or
+#' \code{\link{geom_density_2d}}.  If you have few unique x values,
 #' \code{\link{geom_boxplot}} may also be useful.  Alternatively, you can
 #' summarise the number of points at each location and display that in some
 #' way, using \code{\link{stat_sum}}. Another technique is to use transparent

R/stat-density-2d.r

@@ -1,13 +1,13 @@
 #' @export
-#' @rdname geom_density2d
+#' @rdname geom_density_2d
 #' @param contour If \code{TRUE}, contour the results of the 2d density
 #'   estimation
 #' @param n number of grid points in each direction
 #' @param h Bandwidth (vector of length two). If \code{NULL}, estimated
 #'   using \code{\link[MASS]{bandwidth.nrd}}.
 #' @section Computed variables:
 #' Same as \code{\link{stat_contour}}
-stat_density2d <- function(mapping = NULL, data = NULL, geom = "density2d",
+stat_density_2d <- function(mapping = NULL, data = NULL, geom = "density_2d",
                            position = "identity", contour = TRUE,
                            n = 100, h = NULL, na.rm = FALSE,
                            show.legend = NA, inherit.aes = TRUE, ...) {
@@ -28,6 +28,11 @@ stat_density2d <- function(mapping = NULL, data = NULL, geom = "density2d",
   )
 }
 
+#' @export
+#' @rdname geom_density_2d
+#' @usage NULL
+stat_density2d <- stat_density_2d
+
 #' @rdname ggplot2-ggproto
 #' @format NULL
 #' @usage NULL

inst/staticdocs/index.r

@@ -12,7 +12,7 @@ sd_section("Geoms",
     "geom_curve",
     "geom_crossbar",
     "geom_density",
-    "geom_density2d",
+    "geom_density_2d",
     "geom_dotplot",
     "geom_errorbar",
     "geom_errorbarh",
@@ -50,7 +50,7 @@ sd_section("Statistics",
     "stat_binhex",
     "stat_contour",
     "stat_density",
-    "stat_density2d",
+    "stat_density_2d",
     "stat_ecdf",
     "stat_ellipse",
     "stat_function",