Merge pull request #44 from assignUser/issue43-significant-emoji

- Issue43 significant emoji (#44).

Author: lorenzwalthert

R/analyze.R

@@ -93,7 +93,7 @@ benchmark_verbalize <- function(benchmark, timings, refs, ci) {
   confint <- confint_relative_get(timings, refs, tbl$mean[1], ci = ci)
 
   text <- glue::glue(
-    "* {benchmark}: {tbl$mean[1]}s -> {tbl$mean[2]}s {confint}"
+    "* {confint$emoji}{benchmark}: {tbl$mean[1]}s -> {tbl$mean[2]}s {confint$string}"
   )
   cat(
     text,
@@ -108,6 +108,10 @@ set_sign <- function(x) {
 }
 
 confint_relative_get <- function(timings, refs, reference, ci) {
+  no_change <- "&nbsp;&nbsp;:ballot_box_with_check:"
+  slower <- ":exclamation::snail:"
+  faster <- "&nbsp;&nbsp;:rocket:"
+
   timings_with_factors <- timings %>%
     dplyr::mutate(
       block = factor(.data$block), ref = factor(.data$ref, levels = refs)
@@ -116,7 +120,22 @@ confint_relative_get <- function(timings, refs, reference, ci) {
   fit <- stats::aov(elapsed ~ ref, data = timings_with_factors)
   var <- paste0("ref", refs[2])
   confint <- confint(fit, var, level = ci)
-  paste0("[", paste0(set_sign(round(100 * confint / reference, 2)), collapse = "%, "), "%]")
+  confint <- round(100 * confint / reference, 2)
+  emoji <- confint %>%
+    purrr::when(
+      all(. < 0) ~ faster,
+      all(. > 0) ~ slower,
+      ~ no_change
+    )
+
+  list(
+    string = paste0(
+      "[",
+      paste0(set_sign(confint), collapse = "%, "),
+      "%]"
+    ),
+    emoji = emoji
+  )
 }
 
 
@@ -130,4 +149,4 @@ benchmark_plot <- function(benchmark, timings) {
   fs::path(dir_touchstone(), "plots", benchmark) %>%
     fs::path_ext_set("png") %>%
     ggplot2::ggsave()
-}
+}

R/core.R

@@ -41,7 +41,7 @@ benchmark_run_iteration <- function(expr_before_benchmark,
 
 #' Run a benchmark for git refs
 #'
-#' @param ... Named epression or named character vector of length one with code to benchmark, will
+#' @param ... Named expression or named character vector of length one with code to benchmark, will
 #'   be evaluated with [exprs_eval()].
 #' @param refs Character vector with branch names to benchmark. The package
 #'   must be built for each benchmarked branch beforehand with [refs_install()].

man/benchmark_run_ref.Rd

@@ -11,7 +11,9 @@ test_that("can analyze results", {
     block = 1
   ))
   mockery::stub(
-    benchmark_verbalize, "confint_relative_get", "[x.xx%, y.yy%]",
+    benchmark_verbalize,
+    "confint_relative_get",
+    list(string = "[x.xx%, y.yy%]", emoji = ":rocket:"),
     depth = 2
   )
   benchmarks_analyze(branches)
@@ -49,7 +51,9 @@ test_that("can analyze results", {
   ))
 
   mockery::stub(
-    benchmark_verbalize, "confint_relative_get", "[x.xx%, y.yy%]",
+    benchmark_verbalize,
+    "confint_relative_get",
+    list(string = "[x.xx%, y.yy%]", emoji = ":rocket:"),
     depth = 2
   )
   fs::file_delete(fs::path(dir_touchstone(), "records", "xx1", branches[1]))