nest entire grid_swarm layout procedure within group for better layering of groups with order aesthetic

Author: mjskay

R/RcppExports.R

@@ -1,6 +1,10 @@
 # Generated by using Rcpp::compileAttributes() -> do not edit by hand
 # Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
 
+#' Size diff literal for C++ arrays / vectors
+#' @noRd
+NULL
+
 #' Size literal for C++ arrays / vectors
 #' @noRd
 NULL
@@ -9,16 +13,14 @@ NULL
 #' @noRd
 NULL
 
-#' Can we place `candidate` at this position given the last placed dot and
-#' the previous rows of dots placed so far?
-#' @param reverse <scalar [logical]> are we placing dots in reverse order?
-#' @param candidate <scalar [numeric]> candidate x position
-#' @param rows <[list] of [numeric]> list of previous rows of placed dots
-#' @param n_rows_back <scalar [integer]> actual number of previous rows to consider
-#' @param ygrid <scalar [integer]> max possible number of previous rows in the
-#' y grid that could overlap with this candidate
-#' @param xsize <scalar [numeric]> horizontal spacing between dots
-#' @returns <scalar [logical]> can we place candidate here?
+#' Attempt to place a candidate dot in a target row
+#' @param candidate candidate x position
+#' @param xsize horizontal spacing between dots
+#' @param ygrid size of the y grid (corresponding to 1 + the number of adjacent rows above or
+#' below this row that could overlap with dots in this row)
+#' @param rows rows of already-placed dots
+#' @param target_row iterator pointing at row in `rows` to attempt to place `candidate` in
+#' @returns `true` if the candidate was placed successfully
 #' @noRd
 NULL
 
@@ -31,26 +33,34 @@ NULL
 
 #' const end iterator for forward or reverse iteration
 #' @param reverse iterate in reverse?
-#' @param T iterable type
-#' @param vec object to iterate over
+#' @param C iterable type
+#' @param container object to iterate over
 #' @noRd
 NULL
 
-#' Place dots in a single row in the grid_swarm algorithm
+#' push onto front or back of a container
+#' @param front push onto front?
+#' @param C container type
+#' @param container object to push onto
+#' @noRd
+NULL
+
+#' Attempt to place dots in a specific row in the grid_swarm algorithm
 #' @param reverse are we placing dots in reverse order?
 #' @param both is this a mirrored layout (`side == "both"`?)
-#' @param xsize <scalar [numeric]> horizontal spacing between dots
-#' @param ygrid <scalar [integer]> max possible number of previous rows in the
-#' y grid that  could overlap with this candidate
-#' @param remaining vector of dots to be placed
-#' @param rows <[list] of [numeric]> list of previous rows of placed dots
-#' @param rows_bottom <[list] of [numeric]> list of previous bottom rows of placed dots
-#' (when `both == true`)
+#' @param candidates dots to be placed
+#' @param next_candidates swap space used for next `candidates`
+#' @param xsize horizontal spacing between dots
+#' @param ygrid size of the y grid (corresponding to 1 + the number of adjacent rows above or
+#' below this row that could overlap with dots in this row)
+#' @param rows rows of already-placed dots
+#' @param rows_bottom bottom rows of already-placed dots (when `both == true`)
+#' @param row_i index of `rows` and `rows_bottom` to place candidates in.
 #' @returns `true` if `remaining` may still have dots to place and `false` otherwise
 #' @noRd
 NULL
 
-#' Place dots in `n` rows in the grid_swarm algorithm
+#' Place dots in `n` rows in the grid_swarm algorithm, alternating `reverse`
 #' See `place_row()`
 #' @returns `true` if `remaining` may still have dots to place and `false` otherwise
 #' @noRd
@@ -71,3 +81,14 @@ grid_swarm_ <- function(xs, xsize, ysize, ygrid, side) {
     .Call(`_ggdist_grid_swarm_`, xs, xsize, ysize, ygrid, side)
 }
 
+#' Re-center contiguous clusters around their mean y position so that
+#' small clusters are visually centered (rather than e.g. a cluster of
+#' two points having one point on the origin line and one above it)
+#' @param x sorted numeric vector of dot positions
+#' @param y sorted numeric vector of dot heights, same length as x
+#' @returns modified `y`
+#' @noRd
+recenter_swarm_clusters_ <- function(x, y, binwidth) {
+    .Call(`_ggdist_recenter_swarm_clusters_`, x, y, binwidth)
+}
+

R/bin_dots.R

@@ -262,11 +262,8 @@ recenter_swarm_clusters = function(binner, dots, binning) {
   # re-center contiguous clusters around their mean y position so that
   # small clusters are visually centered (rather than e.g. a cluster of
   # two points having one point on the origin line and one above it)
-  dots$bin = cumsum(c(1L, diff(dots$x) >= binning$binwidth))
-  ddply_(dots, "bin", function(bin_df) {
-    bin_df$y = bin_df$y - mean(bin_df$y)
-    bin_df
-  })
+  dots$y = recenter_swarm_clusters_(dots$x, dots$y, binning$binwidth)
+  dots
 }
 
 #' Get the height of a swarm binning

src/RcppExports.cpp

@@ -22,23 +22,36 @@ BEGIN_RCPP
 END_RCPP
 }
 // grid_swarm_
-SEXP grid_swarm_(std::vector<std::deque<double>> xs, const double xsize, const double ysize, const std::size_t ygrid, const int side);
+SEXP grid_swarm_(std::vector<std::deque<double>> xs, const double xsize, const double ysize, const std::ptrdiff_t ygrid, const int side);
 RcppExport SEXP _ggdist_grid_swarm_(SEXP xsSEXP, SEXP xsizeSEXP, SEXP ysizeSEXP, SEXP ygridSEXP, SEXP sideSEXP) {
 BEGIN_RCPP
     Rcpp::RObject rcpp_result_gen;
     Rcpp::traits::input_parameter< std::vector<std::deque<double>> >::type xs(xsSEXP);
     Rcpp::traits::input_parameter< const double >::type xsize(xsizeSEXP);
     Rcpp::traits::input_parameter< const double >::type ysize(ysizeSEXP);
-    Rcpp::traits::input_parameter< const std::size_t >::type ygrid(ygridSEXP);
+    Rcpp::traits::input_parameter< const std::ptrdiff_t >::type ygrid(ygridSEXP);
     Rcpp::traits::input_parameter< const int >::type side(sideSEXP);
     rcpp_result_gen = Rcpp::wrap(grid_swarm_(xs, xsize, ysize, ygrid, side));
     return rcpp_result_gen;
 END_RCPP
 }
+// recenter_swarm_clusters_
+SEXP recenter_swarm_clusters_(Rcpp::NumericVector& x, Rcpp::NumericVector& y, const double binwidth);
+RcppExport SEXP _ggdist_recenter_swarm_clusters_(SEXP xSEXP, SEXP ySEXP, SEXP binwidthSEXP) {
+BEGIN_RCPP
+    Rcpp::RObject rcpp_result_gen;
+    Rcpp::traits::input_parameter< Rcpp::NumericVector& >::type x(xSEXP);
+    Rcpp::traits::input_parameter< Rcpp::NumericVector& >::type y(ySEXP);
+    Rcpp::traits::input_parameter< const double >::type binwidth(binwidthSEXP);
+    rcpp_result_gen = Rcpp::wrap(recenter_swarm_clusters_(x, y, binwidth));
+    return rcpp_result_gen;
+END_RCPP
+}
 
 static const R_CallMethodDef CallEntries[] = {
     {"_ggdist_wilkinson_bin_to_right_", (DL_FUNC) &_ggdist_wilkinson_bin_to_right_, 2},
     {"_ggdist_grid_swarm_", (DL_FUNC) &_ggdist_grid_swarm_, 5},
+    {"_ggdist_recenter_swarm_clusters_", (DL_FUNC) &_ggdist_recenter_swarm_clusters_, 3},
     {NULL, NULL, 0}
 };