Rename {gguidance} to {legendry} (#25)

* Rename infrastructural parts * rename ggproto doc * rename theme settings * rename remaining remnants * rebuild readme
teunbrand · Oct 8, 2024 · 8812c62 · 8812c62
1 parent 7ced72e
commit 8812c62
Show file tree

Hide file tree

Showing 48 changed files with 230 additions and 228 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -1,4 +1,4 @@
-^gguidance\.Rproj$
+^legendry\.Rproj$
 ^\.Rproj\.user$
 ^LICENSE\.md$
 ^README\.Rmd$

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,4 +1,4 @@
-Package: gguidance
+Package: legendry
 Title: Extended guide options for 'ggplot2'
 Version: 0.0.0.9001
 Authors@R: 
@@ -15,8 +15,8 @@ Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2
 Config/testthat/edition: 3
 VignetteBuilder: knitr
-URL: https://teunbrand.github.io/gguidance/,
-    https://github.com/teunbrand/gguidance
+URL: https://teunbrand.github.io/legendry/,
+    https://github.com/teunbrand/legendry
 Depends: 
     ggplot2 (>= 3.5.0),
     R (>= 4.1.0)

diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,6 @@
-# gguidance 0.0.0.9001
+# legendry 0.0.0.9001
+
+Renamed {gguidance} to {legendry}.
 
 Restarted package from scratch, using a different approach.
 
@@ -8,7 +10,7 @@ Thanks to the following people for catching and reporting early bugs:
 
 ## Mechanism
 
-The crux in gguidance is that you combine a 'key', that contains instructions
+The crux in legendry is that you combine a 'key', that contains instructions
 on which values are represented, with a 'guide' that controls how these values
 are represented.
 

diff --git a/R/compose-.R b/R/compose-.R
@@ -52,7 +52,7 @@ new_compose <- function(guides, args = list(), ...,
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 Compose <- ggproto(
@@ -63,7 +63,7 @@ Compose <- ggproto(
     key = NULL, angle = waiver()
   ),
 
-  elements = list(spacing = "gguidance.guide.spacing"),
+  elements = list(spacing = "legendry.guide.spacing"),
 
   train = function(self, params = self$params, scale, aesthetic = NULL,
                    title = waiver(), ...) {

diff --git a/R/compose-crux.R b/R/compose-crux.R
@@ -83,7 +83,7 @@ compose_crux <- function(
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 ComposeCrux <- ggproto(

diff --git a/R/compose-ontop.R b/R/compose-ontop.R
@@ -54,7 +54,7 @@ compose_ontop <- function(
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 ComposeOntop <- ggproto(

diff --git a/R/compose-sandwich.R b/R/compose-sandwich.R
@@ -74,7 +74,7 @@ compose_sandwich <- function(
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 ComposeSandwich <- ggproto(

diff --git a/R/compose-stack.R b/R/compose-stack.R
@@ -61,7 +61,7 @@ compose_stack <- function(
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 ComposeStack <- ggproto(
@@ -73,9 +73,9 @@ ComposeStack <- ggproto(
   ),
 
   elements = list(
-    side_titles   = "gguidance.axis.subtitle",
-    side_position = "gguidance.axis.subtitle.position",
-    spacing       = "gguidance.guide.spacing"
+    side_titles   = "legendry.axis.subtitle",
+    side_position = "legendry.axis.subtitle.position",
+    spacing       = "legendry.guide.spacing"
   ),
 
   train = function(self, params = self$params, scale, aesthetic = NULL, ...) {

diff --git a/R/gizmo-barcap.R b/R/gizmo-barcap.R
@@ -104,7 +104,7 @@ gizmo_barcap <- function(key = "sequence", shape = "triangle", size = NULL,
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 GizmoBarcap <- ggproto(

diff --git a/R/gizmo-density.R b/R/gizmo-density.R
@@ -77,7 +77,7 @@ gizmo_density <- function(
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 GizmoDensity <- ggproto(

diff --git a/R/gizmo-grob.R b/R/gizmo-grob.R
@@ -62,7 +62,7 @@ gizmo_grob <- function(
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 GizmoGrob <- ggproto(

diff --git a/R/gizmo-histogram.R b/R/gizmo-histogram.R
@@ -77,7 +77,7 @@ gizmo_histogram <- function(
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 GizmoHistogram <- ggproto(

diff --git a/R/gizmo-stepcap.R b/R/gizmo-stepcap.R
@@ -82,7 +82,7 @@ gizmo_stepcap <- function(key = "bins", shape = "triangle", size = NULL, show =
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 GizmoStepcap <- ggproto(

diff --git a/R/guide_axis_base.R b/R/guide_axis_base.R
@@ -58,8 +58,8 @@ guide_axis_base <- function(
   cap = "none", bidi = FALSE, order = 0, position = waiver()
 ) {
   theme <- theme %||% theme()
-  theme$gguidance.guide.spacing <-
-    theme$gguidance.guide.spacing %||% unit(0, "cm")
+  theme$legendry.guide.spacing <-
+    theme$legendry.guide.spacing %||% unit(0, "cm")
 
   compose_stack(
     primitive_line(cap = cap, position = position),

diff --git a/R/guide_axis_nested.R b/R/guide_axis_nested.R
@@ -95,8 +95,8 @@ guide_axis_nested <- function(
 ) {
 
   theme <- theme %||% theme()
-  theme$gguidance.guide.spacing <-
-    theme$gguidance.guide.spacing %||% unit(0, "cm")
+  theme$legendry.guide.spacing <-
+    theme$legendry.guide.spacing %||% unit(0, "cm")
 
   nesting <- switch(
     arg_match0(type, c("bracket", "box", "fence")),

diff --git a/R/guide_colring.R b/R/guide_colring.R
@@ -110,7 +110,7 @@ guide_colring <- function(
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 GuideColring <- ggproto(

diff --git a/R/gguidance-package.R → R/legendry-package.R b/R/gguidance-package.R → R/legendry-package.R
@@ -11,24 +11,24 @@
 ## usethis namespace: end
 NULL
 
-#' @name gguidance_extensions
-#' @title `ggproto` objects in \pkg{gguidance}
+#' @name legendry_extensions
+#' @title `ggproto` objects in \pkg{legendry}
 #'
-#' @description The \pkg{gguidance} package relies on an extension system of
+#' @description The \pkg{legendry} package relies on an extension system of
 #'   \pkg{ggplot2} through [`ggproto`][ggplot2::ggproto] class objects, which
 #'   allow cross-package inheritance of objects such as geoms, stats, facets,
 #'   scales and coordinate systems. For the purpose of making plots, users are
 #'   invited to wholly ignore these objects, since interacting with these
 #'   objects is preferred through various constructor functions. The
-#'   \pkg{gguidance} package introduces a new `<Guide>` ggproto class to support
+#'   \pkg{legendry} package introduces a new `<Guide>` ggproto class to support
 #'   variations on axes, legends and colourbars.
 #'
 #' @seealso The documentation over at [`ggproto`][ggplot2::ggproto()].
 #' @keywords internal
 NULL
 
 #' @name common_parameters
-#' @title common parameters in \pkg{gguidance}
+#' @title common parameters in \pkg{legendry}
 #'
 #' @description
 #' This is a collection of common parameters so they needn't be re-documented

diff --git a/R/primitive-box.R b/R/primitive-box.R
@@ -24,7 +24,7 @@
 #'
 #' Common to both types is the following:
 #'
-#' * `gguidance.box` an [`<element_rect>`][ggplot2::element_rect] for the boxes
+#' * `legendry.box` an [`<element_rect>`][ggplot2::element_rect] for the boxes
 #'   to draw.
 #'
 #' ## As an axis guide
@@ -96,7 +96,7 @@ primitive_box <- function(
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 PrimitiveBox <- ggproto(
@@ -111,8 +111,8 @@ PrimitiveBox <- ggproto(
   ),
 
   elements = list(
-    position = list(text = "axis.text",   box = I("gguidance.box")),
-    legend   = list(text = "legend.text", box = I("gguidance.box"))
+    position = list(text = "axis.text",   box = I("legendry.box")),
+    legend   = list(text = "legend.text", box = I("legendry.box"))
   ),
 
   extract_key = range_extract_key,

diff --git a/R/primitive-bracket.R b/R/primitive-bracket.R
@@ -40,9 +40,9 @@
 #'
 #' Common to both types is the following:
 #'
-#' * `gguidance.bracket` an [`<element_line>`][ggplot2::element_line] for the
+#' * `legendry.bracket` an [`<element_line>`][ggplot2::element_line] for the
 #'   line used to draw the brackets.
-#' * `gguidance.backet.size` a [`<unit>`][grid::unit] setting the space afforded
+#' * `legendry.backet.size` a [`<unit>`][grid::unit] setting the space afforded
 #'   to a bracket.
 #'
 #' ## As an axis guide
@@ -115,7 +115,7 @@ primitive_bracket <- function(
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 PrimitiveBracket <- ggproto(
@@ -131,12 +131,12 @@ PrimitiveBracket <- ggproto(
 
   elements = list(
     position = list(
-      text = "axis.text", line = I("gguidance.bracket"),
-      size = I("gguidance.bracket.size")
+      text = "axis.text", line = I("legendry.bracket"),
+      size = I("legendry.bracket.size")
     ),
     legend = list(
-      text = "legend.text", line = I("gguidance.bracket"),
-      size = I("gguidance.bracket.size")
+      text = "legend.text", line = I("legendry.bracket"),
+      size = I("legendry.bracket.size")
     )
   ),
 

diff --git a/R/primitive-fence.R b/R/primitive-fence.R
@@ -30,9 +30,9 @@
 #'
 #' Common to both types is the following:
 #'
-#' * `gguidance.fence.post` an [`<element_line>`][ggplot2::element_line] for the
+#' * `legendry.fence.post` an [`<element_line>`][ggplot2::element_line] for the
 #'   line used to draw the pieces orthogonal to the direction of the scale.
-#' * `gguidance.fence.rail` an [`<element_line>`][ggplot2::element_line] for the
+#' * `legendry.fence.rail` an [`<element_line>`][ggplot2::element_line] for the
 #'   line used to draw the pieces parallel to the direction of the scale.
 #'
 #' ## As an axis guide
@@ -113,7 +113,7 @@ primitive_fence <- function(
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 PrimitiveFence <- ggproto(
@@ -131,13 +131,13 @@ PrimitiveFence <- ggproto(
   elements = list(
     position = list(
       text = "axis.text",
-      post = I("gguidance.fence.post"),
-      rail = I("gguidance.fence.rail")
+      post = I("legendry.fence.post"),
+      rail = I("legendry.fence.rail")
     ),
     legend = list(
       text = "legend.text",
-      post = I("gguidance.fence.post"),
-      rail = I("gguidance.fence.rail")
+      post = I("legendry.fence.post"),
+      rail = I("legendry.fence.rail")
     )
   ),
 

diff --git a/R/primitive-labels.R b/R/primitive-labels.R
@@ -73,7 +73,7 @@ primitive_labels <- function(key = NULL, angle = waiver(), n.dodge = 1,
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 PrimitiveLabels <- ggproto(

diff --git a/R/primitive-line.R b/R/primitive-line.R
@@ -67,7 +67,7 @@ primitive_line <- function(key = NULL, cap = "none", theme = NULL,
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 PrimitiveLine <- ggproto(

diff --git a/R/primitive-spacer.R b/R/primitive-spacer.R
@@ -19,7 +19,7 @@
 #' this guide. This guide does not have option dependent on its role as axis or
 #' legend.
 #'
-#' * `gguidance.guide.spacing` A [`<unit>`][grid::unit] setting the amount of
+#' * `legendry.guide.spacing` A [`<unit>`][grid::unit] setting the amount of
 #'   spacing when the `space` argument is `NULL`.
 #'
 #' @examples
@@ -41,7 +41,7 @@ primitive_spacer <- function(space = NULL, title = waiver(),
 # Class -------------------------------------------------------------------
 
 #' @export
-#' @rdname gguidance_extensions
+#' @rdname legendry_extensions
 #' @format NULL
 #' @usage NULL
 PrimitiveSpacer <- ggproto(
@@ -63,7 +63,7 @@ PrimitiveSpacer <- ggproto(
   draw = function(self, theme, position = NULL, direction = NULL,
                   params = self$params) {
     space <- params$space %||%
-      calc_element("gguidance.guide.spacing", theme + params$theme)
+      calc_element("legendry.guide.spacing", theme + params$theme)
     primitive_grob(
       zeroGrob(), sum(space), params$position %||% position, "spacer"
     )