still experimental

NAMESPACE

@@ -48,7 +48,7 @@ export(resect)
 export(rotate)
 export(round_probability)
 export(set_props)
-export(shape_array)
+export(ob_array)
 export(subscript)
 export(superscript)
 export(turn)

R/a_early.R

@@ -222,7 +222,7 @@ ob_covariance <- new_generic(
 #' @param anchor bounding box anchor
 #' @param ... <[`dynamic-dots`][rlang::dyn-dots]> properties passed to shape
 #' @export
-shape_array <- new_generic(name = "make_array", dispatch_args = "x", fun = function(x, k = 2, sep = 1, where = "east", anchor = "center", ...) {
+ob_array <- new_generic(name = "ob_array", dispatch_args = "x", fun = function(x, k = 2, sep = 1, where = "east", anchor = "center", ...) {
   S7_dispatch()
 })
 
@@ -514,7 +514,7 @@ replace_na <- function(x, y) {
 
 
 #' @keywords internal
-shape_array_helper <- function(x, k = 2, sep = 1, where = "east", anchor = "center", ...) {
+ob_array_helper <- function(x, k = 2, sep = 1, where = "east", anchor = "center", ...) {
   if (x@length > 1) stop("The shape must start with an object of length 1.")
 
   dots <- rlang::list2(...)

R/circles.R

@@ -312,7 +312,7 @@ method(place, list(ob_line, ob_circle)) <- function(x, from, where = "right", se
   from@tangent_at(where)
 }
 
-method(shape_array, ob_circle) <- function(x, k = 2, sep = 1, where = "east", anchor = "center", ...) {
+method(ob_array, ob_circle) <- function(x, k = 2, sep = 1, where = "east", anchor = "center", ...) {
   # s <- seq(0, (sep + x@radius) * (k - 1), sep + x@radius)
   # px <- cos(degree(where)) * s
   # py <- sin(degree(where)) * s
@@ -325,7 +325,7 @@ method(shape_array, ob_circle) <- function(x, k = 2, sep = 1, where = "east", an
   # }
   # ob_circle(p@center - p_anchor + x@center, style = x@style, ...)
 
-  sa <- shape_array_helper(x = x, k = k, sep = sep, where = where, anchor = anchor, ...)
+  sa <- ob_array_helper(x = x, k = k, sep = sep, where = where, anchor = anchor, ...)
 
   rlang::inject(ob_circle(center = sa$p_center,
                         radius = x@radius,

R/ellipses.R

@@ -654,9 +654,9 @@ method(place, list(ob_line, ob_ellipse)) <- function(x, from, where = "right", s
 
 
 
-method(shape_array, ob_ellipse) <- function(x, k = 2, sep = 1, where = "east", anchor = "center", ...) {
+method(ob_array, ob_ellipse) <- function(x, k = 2, sep = 1, where = "east", anchor = "center", ...) {
 
-  sa <- shape_array_helper(x = x, k = k, sep = sep, where = where, anchor = anchor, ...)
+  sa <- ob_array_helper(x = x, k = k, sep = sep, where = where, anchor = anchor, ...)
 
   rlang::inject(ob_ellipse(sa$p_center,
                         a = x@a,

R/points.R

@@ -435,7 +435,7 @@ method(nudge, list(ob_point, class_missing, class_numeric)) <- function(object,
   object + ob_point(0, y)
 }
 
-method(shape_array, ob_point) <- function(x, k = 2, sep = 1, where = "east", anchor = "center", ...) {
+method(ob_array, ob_point) <- function(x, k = 2, sep = 1, where = "east", anchor = "center", ...) {
   s <- seq(0, sep * (k - 1), sep)
   px <- cos(degree(where)) * s
   py <- sin(degree(where)) * s

README.md

@@ -9,7 +9,7 @@
 
 The ggdiagram package takes an object-oriented approach to making diagrams and plots the results using [ggplot2](https://ggplot2.tidyverse.org/).
 
-This package is in the early stages of construction. It has some structural beams and a bit of plumbing but is not yet capable of fulfilling its eventual purpose. 
+This package is still experimental, and functions are likely to change in many ways. Every time I run into speed bumps or inconveniences as I use the program in practice, I adapt it to anticipate user needs.
 
 My motivation in making ggdiagram was to find a way to approach the functionality of TikZ but with the flexibility and convenience of R. The ggdiagram package is built atop [S7](https://rconsortium.github.io/S7/) and is integrated with [ggplot2](https://ggplot2.tidyverse.org/), making heavy use of [ggtext](https://wilkelab.org/ggtext/), [ggforce](https://ggforce.data-imaginist.com/), and [ggarrow](https://teunbrand.github.io/ggarrow/).