improve docs

Author: teunbrand

R/geom-bin2d.R

@@ -25,7 +25,7 @@ NULL
 #' # You can control the size of the bins by specifying the number of
 #' # bins in each direction:
 #' d + geom_bin_2d(bins = 10)
-#' d + geom_bin_2d(bins = 30)
+#' d + geom_bin_2d(bins = list(x = 30, y = 10))
 #'
 #' # Or by specifying the width of the bins
 #' d + geom_bin_2d(binwidth = c(0.1, 0.1))

R/stat-bin2d.R

@@ -1,7 +1,4 @@
-#' @param bins numeric vector giving number of bins in both vertical and
-#'   horizontal directions. Set to 30 by default.
-#' @param binwidth Numeric vector giving bin width in both vertical and
-#'   horizontal directions. Overrides `bins` if both set.
+#' @inheritParams stat_bin
 #' @param drop if `TRUE` removes all cells with 0 counts.
 #' @export
 #' @rdname geom_bin_2d
@@ -11,11 +8,21 @@
 #'   ncount   = "count, scaled to maximum of 1.",
 #'   ndensity = "density, scaled to a maximum of 1."
 #' )
+#' @section Controlling binning parameters for the x and y directions:
+#' The arguments `bins`, `binwidth`, `breaks`, `center`, and `boundary` can
+#' be set separately for the x and y directions. When given as a scalar, one
+#' value applies to both directions. When given as a vector of length two,
+#' the first is applied to the x direction and the second to the y direction.
+#' Alternatively, these can be a named list containing `x` and `y` elements,
+#' for example `list(x = 10, y = 20)`.
 stat_bin_2d <- function(mapping = NULL, data = NULL,
                         geom = "tile", position = "identity",
                         ...,
                         bins = 30,
                         binwidth = NULL,
+                        center = NULL,
+                        boundary = NULL,
+                        breaks = NULL,
                         drop = TRUE,
                         na.rm = FALSE,
                         show.legend = NA,
@@ -31,6 +38,9 @@ stat_bin_2d <- function(mapping = NULL, data = NULL,
     params = list2(
       bins = bins,
       binwidth = binwidth,
+      center = center,
+      boundary = boundary,
+      breaks = breaks,
       drop = drop,
       na.rm = na.rm,
       ...

R/stat-binhex.R

@@ -7,6 +7,13 @@
 #'   ncount   = "count, scaled to maximum of 1.",
 #'   ndensity = "density, scaled to maximum of 1."
 #' )
+#' @section Controlling binning parameters for the x and y directions:
+#' The arguments `bins` and `binwidth` can
+#' be set separately for the x and y directions. When given as a scalar, one
+#' value applies to both directions. When given as a vector of length two,
+#' the first is applied to the x direction and the second to the y direction.
+#' Alternatively, these can be a named list containing `x` and `y` elements,
+#' for example `list(x = 10, y = 20)`.
 stat_bin_hex <- function(mapping = NULL, data = NULL,
                          geom = "hex", position = "identity",
                          ...,

R/stat-summary-2d.R

@@ -28,6 +28,7 @@
 #' @param drop drop if the output of `fun` is `NA`.
 #' @param fun function for summary.
 #' @param fun.args A list of extra arguments to pass to `fun`
+#' @inheritSection stat_bin_2d Controlling binning parameters for the x and y directions
 #' @export
 #' @examples
 #' d <- ggplot(diamonds, aes(carat, depth, z = price))