note on stats='boxplot' for geom_tufteboxplot

R/geom-tufteboxplot.R

@@ -53,6 +53,13 @@
 #' @param hoffset controls how much the interquartile line is offset from the
 #'    whiskers when \code{median.type = 'line'}. This is a fraction of the
 #'    range of \code{x}.
+#' @param  stat The statistical transformation to use on the data for this
+#'    layer, as a string. The default (\code{stat = 'fivenumber'}) calls
+#'    \code{\link{stat_fivenumber}} and produces whiskers that extend
+#'    from the interquartile range to the extremes of the data; specifying
+#'    \code{\link{stat_boxplot}} will produce a more traditional boxplot
+#'    with whiskers extending to the most extreme points that are < 1.5 IQR
+#'    away from the hinges (i.e., the first and third quartiles).
 #' @family geom tufte
 #' @export
 #'

inst/examples/ex-geom_tufteboxplot.R

@@ -13,3 +13,5 @@ p + geom_tufteboxplot(median.type = "line")
 p + geom_tufteboxplot() +
   theme_tufte() +
   theme(axis.ticks.x = element_blank())
+# traditional boxplot with whiskers only out to 1.5 IQR, outlier points
+p + geom_tufteboxplot(stat="boxplot", outlier.shape = 5)