add refs to thickness article from other docs, closes #205

mjskay · Feb 10, 2024 · 64b5828 · 64b5828
1 parent 2a164da
commit 64b5828
Show file tree

Hide file tree

Showing 24 changed files with 102 additions and 34 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -22,7 +22,7 @@ New features and enhancements:
 Documentation:
 
 * The pkgdown documentation now includes an online article on the `thickness`
-  aesthetic and how its scaling works.
+  aesthetic and with comprehensive examples of how slab scaling works (#205).
 
 Bug fixes:
 

diff --git a/R/auto_partial.R b/R/auto_partial.R
@@ -147,7 +147,7 @@ auto_partial = function(f, name = NULL) {
     # the partial self function
     quote(partial_self)
   } else {
-    # when auto_partial is called from within the ggdist namespace, we need to
+    # when auto_partial is called from outside the ggdist namespace, we need to
     # inline the partial_self function so that it is guaranteed to be found
     partial_self
   }

diff --git a/R/geom_slabinterval.R b/R/geom_slabinterval.R
@@ -475,7 +475,9 @@ GeomSlabinterval = ggproto("GeomSlabinterval", AbstractGeom,
       sides (as in a violin plot).',
       scale =
         'What proportion of the region allocated to this geom to use to draw the slab. If `scale = 1`,
-      slabs that use the maximum range will just touch each other. Default is `0.9` to leave some space.',
+      slabs that use the maximum range will just touch each other. Default is `0.9` to leave some space
+      between adjacent slabs. For a comprehensive discussion and examples of slab scaling and normalization,
+      see the [`thickness` scale article](https://mjskay.github.io/ggdist/articles/thickness.html).',
       justification =
         'Justification of the interval relative to the slab, where `0` indicates bottom/left
       justification and `1` indicates top/right justification (depending on `orientation`). If `justification`
@@ -653,6 +655,8 @@ GeomSlabinterval = ggproto("GeomSlabinterval", AbstractGeom,
         \\item `"none"`: values are taken as is with no normalization (this should probably
           only be used with functions whose values are in \\[0,1\\], such as CDFs).
       }
+      For a comprehensive discussion and examples of slab scaling and normalization, see the
+      [`thickness` scale article](https://mjskay.github.io/ggdist/articles/thickness.html).
       '),
     fill_type = glue_doc('
       What type of fill to use when the fill color or alpha varies within a slab. One of:

diff --git a/R/scale_thickness.R b/R/scale_thickness.R
@@ -13,6 +13,8 @@
 #' that support the `thickness` aesthetic (such as [geom_slabinterval()]). It
 #' can be used to align the `thickness` scales across multiple geoms (by default,
 #' `thickness` is normalized on a per-geom level instead of as a global scale).
+#' For a comprehensive discussion and examples of slab scaling and normalization,
+#' see the [`thickness` scale article](https://mjskay.github.io/ggdist/articles/thickness.html).
 #'
 #' @inheritParams ggplot2::continuous_scale
 #' @inheritDotParams ggplot2::continuous_scale

diff --git a/man/geom_dots.Rd b/man/geom_dots.Rd
diff --git a/man/geom_dotsinterval.Rd b/man/geom_dotsinterval.Rd
diff --git a/man/geom_slab.Rd b/man/geom_slab.Rd
diff --git a/man/geom_slabinterval.Rd b/man/geom_slabinterval.Rd
diff --git a/man/geom_spike.Rd b/man/geom_spike.Rd
diff --git a/man/geom_swarm.Rd b/man/geom_swarm.Rd
diff --git a/man/geom_weave.Rd b/man/geom_weave.Rd
diff --git a/man/scale_thickness.Rd b/man/scale_thickness.Rd
diff --git a/man/stat_ccdfinterval.Rd b/man/stat_ccdfinterval.Rd
diff --git a/man/stat_cdfinterval.Rd b/man/stat_cdfinterval.Rd
diff --git a/man/stat_dots.Rd b/man/stat_dots.Rd
diff --git a/man/stat_dotsinterval.Rd b/man/stat_dotsinterval.Rd