v0.3.0 added additional options for letter aesthetics

Author: ethanbass

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: ggtukey
 Title: Compact Letter Displays for 'ggplot2'
-Version: 0.2.0
+Version: 0.3.0
 Authors@R: 
     person("Ethan", "Bass", , "ethanbass@gmail.com", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-6175-6739"))

NEWS.md

@@ -1,3 +1,7 @@
+# ggtukey 0.3.0 dev
+
+* Added additional parameters to `geom_tukey` (`geom`, `color`, `fill,` & `alpha`) for further customization of letters.
+
 # ggtukey 0.2.0
 
 * Added additional options to `where` parameter for placement of letters.

R/boxplot_letters.R

@@ -89,7 +89,7 @@ boxplot_letters <- function(data, x, y, fill, group, test = c("tukey", "kruskalm
     geom_box <- purrr::partial(geom_boxplot, color = "black", fill = {{fill}})
   }
 
-  p <- data %>% #Dataframe from which data will be drawn
+  p <- data %>% # Dataframe from which data will be drawn
     ggplot(aes(x = {{x}}, y = {{y}})) +
     geom_box() +
     theme_article() + #Clean, minimal theme courtesy of the "egg" package
@@ -117,7 +117,7 @@ boxplot_letters <- function(data, x, y, fill, group, test = c("tukey", "kruskalm
     }
   }
   if (!missing(group)){
-    p <- p <- p + facet_wrap(vars({{group}}))
+    p <- p + facet_wrap(vars({{group}}))
   }
   p + geom_tukey(test = test, type = type, where = where,
                  hjust = hjust, vjust = vjust, size = lab_size,

R/geom_tukey.R

@@ -5,17 +5,21 @@
 #' @param type If a grouping variable is provided, determines whether to run
 #' separate tests for each facet (\code{one-way}) or one (\code{two-way}) test with
 #' an interaction term between \code{x} and \code{group}. Defaults to \code{two-way}.
+#' @param threshold Statistical threshold for significance. Defaults to 0.05.
 #' @param where Where to put the letters. Either above the box (\code{box}) or
 #' upper whisker (\code{whisker}) of a boxplot; at the \code{mean} or
 #' \code{median}; or at the top of the error bars calculated from the standard
 #' error (\code{se}), standard deviation \code{sd}, or 95% confidence intervals
 #' returned by \code{\link[Hmisc]{smean.cl.normal}}, or \code{\link[Hmisc]{smean.cl.boot}}.
 #' @param hjust Horizontal adjustment of the label. (Argument to \code{\link[ggplot2]{geom_text}}).
 #' @param vjust Vertical adjustment of the label. (Argument to \code{\link[ggplot2]{geom_text}}).
+#' @param geom Which geom to use to plot letters. Options are \code{text} and \code{label}.
 #' @param size Label size. Argument to \code{\link[ggplot2]{geom_text}}.
+#' @param color Label color.
+#' @param fill Label fill (only applies if \code{geom == "label"}).
+#' @param alpha Label transparency. Defaults to 1.
 #' @param na.rm Logical. Whether to remove observations with NAs for the provided
 #' factors (i.e. \code{x} and \code{group}) before plotting. Defaults to TRUE.
-#' @param threshold Statistical threshold for significance. Defaults to 0.05.
 #' @author Ethan Bass
 #' @references
 #' * Piepho, Hans-Peter. An Algorithm for a Letter-Based Representation of
@@ -43,11 +47,13 @@
 #' data |> ggplot(aes(x=Size, y=Value)) + geom_boxplot() + facet_wrap(~Category) + geom_tukey()
 #' @export
 
-geom_tukey <- function(test = c("tukey","kruskalmc"), threshold = 0.05,
-                       type=c("two-way", "one-way"),
+geom_tukey <- function(test = c("tukey","kruskalmc"),
+                       type=c("two-way", "one-way"), threshold = 0.05,
                        where = c("box","whisker", "mean", "median", "se", "sd",
                                  "cl_normal", "cl_boot"),
-                       hjust = 0, vjust = -0.2, size = 4, na.rm = TRUE){
+                       hjust = 0, vjust = -0.2, geom="text",
+                       size = 4, color="black", fill="white",
+                       alpha = 1, na.rm = TRUE){
   # store inputs in classed output that can
   # be passed to a `ggplot_add` method
   test <- match.arg(test, c("tukey", "kruskalmc"))
@@ -71,7 +77,11 @@ geom_tukey <- function(test = c("tukey","kruskalmc"), threshold = 0.05,
     vjust = vjust,
     size = size,
     na.rm = na.rm,
-    threshold = threshold
+    threshold = threshold,
+    color = color,
+    geom=geom,
+    alpha=alpha,
+    fill=fill
   )
 }
 
@@ -80,7 +90,8 @@ geom_tukey <- function(test = c("tukey","kruskalmc"), threshold = 0.05,
 geom_tukey_ <- function(p, test = c("tukey","kruskalmc"), threshold = 0.05,
                         type=c("two-way", "one-way"),
                         where = c("box","whisker", "mean","median", "se", "sd","cl_normal","cl_boot"),
-                        hjust = 0, vjust = 0, size = 4, na.rm = TRUE) {
+                        hjust = 0, vjust = 0, size = 4, geom="text",
+                        color="black", fill="white", alpha=1, na.rm = TRUE) {
   data <- p$data
   if (na.rm){
     data <- drop_na(data, !!p$mapping$x, !!p$facet$params$facets[[1]])
@@ -104,9 +115,18 @@ geom_tukey_ <- function(p, test = c("tukey","kruskalmc"), threshold = 0.05,
                                 threshold = threshold)
     }
   }
-  geom_text(data = data,
-            aes(y = .data$Placement.Value, label = .data$Letter), hjust = hjust,
-            vjust = vjust, size = size)
+  if (geom =="text"){
+    geom_text(data = data,
+              aes(y = .data$Placement.Value, label = .data$Letter), hjust = hjust,
+              vjust = vjust, size = size, color=color, alpha=alpha)
+  } else if (geom == "label"){
+    geom_label(data = data,
+              aes(y = .data$Placement.Value, label = .data$Letter), hjust = hjust,
+              vjust = vjust, size = size, color=color, alpha=alpha,
+              label.size = 0, fill=fill)
+  }
+
+
 }
 
 #' @name ggplot_add.geom_tukey

R/utils.R

@@ -24,6 +24,9 @@ get_tukey_letters <- function(data, x, y, group = NULL, test = c("tukey", "krusk
   where <- match.arg(where, c("box", "whisker", "mean","median", "se", "sd",
                               "cl_normal", "cl_boot"))
   type <- match.arg(type, c("two-way", "one-way"))
+  # if (any(grepl("-", levels(data[,rlang::as_name(x), drop = TRUE])))){
+  #   stop("Factor names cannot contain dashes. Please recode factor levels before proceeding.")
+  # }
   if (inherits(x, "quosure") & is.null(group)){
     letters.df <- place_tukey_letters(data, as_name(x), as_name(y), test = test,
                                       where = where, threshold = threshold)

README.md

@@ -54,7 +54,7 @@ For more examples and details on different options for customization, please con
 
 You can cite `ggtukey` as follows:
 
-Bass, E. (2022). ggtukey: Compact Letter Displays for 'ggplot2' (v0.2.0). (https://ethanbass.github.io/ggtukey/). 
+Bass, E. (2022). ggtukey: Compact Letter Displays for 'ggplot2' (v0.3.0). (https://ethanbass.github.io/ggtukey/). 
 
 # Further Reading
 

inst/CITATION

@@ -5,10 +5,10 @@ citEntry(
   title    = "ggtukey: Compact Letter Displays for 'ggplot2'",
   author   = "Ethan Bass",
   year     = "2023",
-  note     = "version 0.2.0",
+  note     = "version 0.3.0",
   url      = "https://ethanbass.github.io/ggtukey/",
   doi      = "",
   textVersion = paste("Bass, E. (2023).",
-        "ggtukey: Compact Letter Displays for 'ggplot2' (version 0.2.0)."
+        "ggtukey: Compact Letter Displays for 'ggplot2' (version 0.3.0)."
         )
   )