Crosslink documentation with book (#5678)

* crosslink docs with book

* Add helper function

* Use helper function

Author: teunbrand

R/annotation.R

@@ -20,6 +20,8 @@
 #'   you must specify at least one of these.
 #' @inheritParams layer
 #' @inheritParams geom_point
+#' @seealso
+#' The `r link_book("custom annotations section", "annotations#sec-custom-annotations")`
 #' @export
 #' @examples
 #' p <- ggplot(mtcars, aes(x = wt, y = mpg)) + geom_point()

R/coord-.R

@@ -44,6 +44,8 @@
 #'     system to manipulate the `layout` data frame which assigns
 #'     data to panels and scales.
 #'
+#' See also the `r link_book("new coords section", "extensions#sec-new-coords")`
+#'
 #' @rdname ggplot2-ggproto
 #' @format NULL
 #' @usage NULL

R/coord-map.R

@@ -45,6 +45,8 @@
 #'   setting of `"on"` (the default) means yes, and a setting of `"off"`
 #'   means no. For details, please see [`coord_cartesian()`].
 #' @export
+#' @seealso
+#' The `r link_book("polygon maps section", "maps#sec-polygonmaps")`
 #' @examples
 #' if (require("maps")) {
 #' nz <- map_data("nz")

R/coord-polar.R

@@ -12,6 +12,8 @@
 #'   setting of `"on"` (the default) means yes, and a setting of `"off"`
 #'   means no. For details, please see [`coord_cartesian()`].
 #' @export
+#' @seealso
+#' The `r link_book("polar coordinates section", "coord#polar-coordinates-with-coord_polar")`
 #' @examples
 #' # NOTE: Use these plots with caution - polar coordinates has
 #' # major perceptual problems.  The main point of these examples is

R/coord-transform.R

@@ -11,6 +11,8 @@
 #' @inheritParams coord_cartesian
 #' @param x,y Transformers for x and y axes or their names.
 #' @param limx,limy `r lifecycle::badge("deprecated")` use `xlim` and `ylim` instead.
+#' @seealso
+#' The `r link_book("coord transformations section", "coord#transformations-with-coord_trans")`
 #' @export
 #' @examples
 #' \donttest{

R/facet-.R

@@ -74,6 +74,8 @@ NULL
 #' parameter which is used to determine if scales are retrained after Stat
 #' transformations has been applied.
 #'
+#' See also the `r link_book("new facets section", "extensions#new-facets")`
+#'
 #' @rdname ggplot2-ggproto
 #' @format NULL
 #' @usage NULL

R/facet-grid-.R

@@ -70,6 +70,8 @@ NULL
 #'   draws the labels at the interior axes in the x- or y-direction
 #'   respectively.
 #' @export
+#' @seealso
+#' The `r link_book("facet grid section", "facet#facet-grid")`
 #' @examples
 #' p <- ggplot(mpg, aes(displ, cty)) + geom_point()
 #'

R/facet-wrap.R

@@ -35,6 +35,8 @@ NULL
 #'   `"all_x"` or `"all_y"`, only draws the labels at the interior axes in the
 #'   x- or y-direction respectively.
 #' @inheritParams facet_grid
+#' @seealso
+#' The `r link_book("facet wrap section", "facet#sec-facet-wrap")`
 #' @export
 #' @examples
 #' p <- ggplot(mpg, aes(displ, hwy)) + geom_point()

R/geom-.R

@@ -50,6 +50,8 @@ NULL
 #'     default values for aesthetics.
 #'   - `setup_data`: Converts width and height to xmin and xmax,
 #'     and ymin and ymax values. It can potentially set other values as well.
+#'
+#' See also the `r link_book("new geoms section", "extensions#sec-new-geoms")`
 #' @rdname ggplot2-ggproto
 #' @format NULL
 #' @usage NULL

R/geom-sf.R

@@ -59,7 +59,11 @@
 #'
 #'   You can also set this to one of "polygon", "line", and "point" to
 #'   override the default legend.
-#' @seealso [stat_sf_coordinates()]
+#'
+#' @seealso
+#' The `r link_book("simple feature maps section", "maps#sec-sf")`
+#'
+#' [stat_sf_coordinates()]
 #' @examples
 #' if (requireNamespace("sf", quietly = TRUE)) {
 #' nc <- sf::st_read(system.file("shape/nc.shp", package = "sf"), quiet = TRUE)