replace rd_orientation() with @inheritSection

Author: teunbrand

R/geom-bar.R

@@ -66,7 +66,7 @@ GeomBar <- ggproto(
 #' [position_fill()] shows relative proportions at each `x` by stacking the
 #' bars and then standardising each bar to have the same height.
 #'
-#' @eval rd_orientation()
+#' @inheritSection shared_layer_parameters Orientation
 #'
 #' @aesthetics GeomBar
 #' @aesthetics GeomCol

R/geom-boxplot.R

@@ -4,7 +4,7 @@
 #' It visualises five summary statistics (the median, two hinges
 #' and two whiskers), and all "outlying" points individually.
 #'
-#' @eval rd_orientation()
+#' @inheritSection shared_layer_parameters Orientation
 #'
 #' @section Summary statistics:
 #' The lower and upper hinges correspond to the first and third quartiles

R/geom-density.R

@@ -21,7 +21,7 @@ GeomDensity <- ggproto(
 #' the histogram. This is a useful alternative to the histogram for continuous
 #' data that comes from an underlying smooth distribution.
 #'
-#' @eval rd_orientation()
+#' @inheritSection shared_layer_parameters Orientation
 #' @aesthetics GeomDensity
 #' @seealso See [geom_histogram()], [geom_freqpoly()] for
 #'   other methods of displaying continuous distribution.

R/geom-histogram.R

@@ -27,7 +27,7 @@
 #' `scale_x_binned()` with [geom_bar()]. This method by default plots tick marks
 #' in between each bar.
 #'
-#' @eval rd_orientation()
+#' @inheritSection shared_layer_parameters Orientation
 #'
 #' @section Aesthetics:
 #' `geom_histogram()` uses the same aesthetics as [geom_bar()];

R/geom-linerange.R

@@ -42,7 +42,7 @@ GeomLinerange <- ggproto(
 #' Various ways of representing a vertical interval defined by `x`,
 #' `ymin` and `ymax`. Each case draws a single graphical object.
 #'
-#' @eval rd_orientation()
+#' @inheritSection shared_layer_parameters Orientation
 #'
 #' @aesthetics GeomLinerange
 #' Note that `geom_pointrange()` also understands `size` for the size of the points.

R/geom-path.R

@@ -178,7 +178,7 @@ GeomStep <- ggproto(
 #' An alternative parameterisation is [geom_segment()], where each line
 #' corresponds to a single case which provides the start and end coordinates.
 #'
-#' @eval rd_orientation()
+#' @inheritSection shared_layer_parameters Orientation
 #'
 #' @aesthetics GeomPath
 #' @inheritParams shared_layer_parameters

R/geom-ribbon.R

@@ -241,7 +241,7 @@ GeomArea <- ggproto("GeomArea", GeomRibbon,
 #' of x-coordinates. To turn off this interpolation, `stat = "identity"` can
 #' be used instead.
 #'
-#' @eval rd_orientation()
+#' @inheritSection shared_layer_parameters Orientation
 #'
 #' @aesthetics GeomRibbon
 #' @seealso

R/geom-smooth.R

@@ -74,7 +74,7 @@ GeomSmooth <- ggproto(
 #' `glm()`, where the normal confidence band is constructed on the link
 #' scale and then back-transformed to the response scale.
 #'
-#' @eval rd_orientation()
+#' @inheritSection shared_layer_parameters Orientation
 #'
 #' @aesthetics GeomSmooth
 #' @inheritParams shared_layer_parameters

R/geom-violin.R

@@ -5,7 +5,7 @@
 #' violin plot is a mirrored density plot displayed in the same way as a
 #' boxplot.
 #'
-#' @eval rd_orientation()
+#' @inheritSection shared_layer_parameters Orientation
 #'
 #' @aesthetics GeomViolin
 #' @inheritParams shared_layer_parameters

R/layer.R

@@ -107,6 +107,17 @@
 #' can be given explicitly by setting `orientation` to either `"x"` or `"y"`.
 #' See the *Orientation* section for more detail.
 #'
+#' @section Orientation:
+#' This geom treats each axis differently and, thus, can thus have two
+#' orientations. Often the orientation is easy to deduce from a combination of
+#' the given mappings and the types of positional scales in use. Thus, ggplot2
+#' will by default try to guess which orientation the layer should have. Under
+#' rare circumstances, the orientation is ambiguous and guessing may fail. In
+#' that case the orientation can be specified directly using the `orientation`
+#' parameter, which can be either `"x"` or `"y"`. The value gives the axis that
+#' the geom should run along, `"x"` being the default orientation you would
+#' expect for the geom.
+#'
 #' @keywords internal
 #' @aliases NULL
 NULL