Reorder microbenchmark results based on optional ordervar

Author: eddelbuettel

ChangeLog

@@ -1,3 +1,7 @@
+2025-12-16  Dirk Eddelbuettel  <edd@debian.org>
+
+	* R/reorderMicrobenchmarkResults.R: Use 'ordervar' to order
+
 2025-11-29  Dirk Eddelbuettel  <edd@debian.org>
 
 	* .github/workflows/ci.yaml: Switch to actions/checkout@v6

R/reorderMicrobenchmarkResults.R

@@ -9,15 +9,18 @@
 #'
 #' @title Reorder microbenchmark Results
 #' @param res An object returned from `microbenchmark::microbenchmark`
-#' @param order An option character variable selecting a column to order on,
+#' @param ordervar An option character variable selecting a column to order on,
 #' defaults to 'median'
 #' @return A modified version of `res` with an ordering by `order`
-reorderMicrobenchmarkResults <- function(res, order="median") {
-    stopifnot("Argument 'res' must be a 'microbenchmark' result" = inherits(res, "microbenchmark"))
+reorderMicrobenchmarkResults <- function(res, ordervar="median") {
+    stopifnot("Argument 'res' must be a 'microbenchmark' result" =
+                  inherits(res, "microbenchmark"),
+              "Argument 'ordervar' must be a column name in 'summary(res)'" =
+                  is.finite(match(ordervar, names(summary(res)))))
 
     smry <- summary(res)
     res$expr <- factor(res$expr,
-                       levels = levels(res$expr)[order(smry[["median"]])],
+                       levels = levels(res$expr)[order(smry[[ordervar]])],
                        ordered = TRUE)
     res
 }