Handle xmin/xmax/ymin/ymax along with model.frame (#403)

* handle xmin/xmax/ymin/ymax along with model.frame

* turn facet into a formula if it does not evaluate successfully

* document min/max processing in NEWS and ?tinyplot

* typo

* use formula-based syntax for pointrange/errorbar

* run devtools::document

Author: zeileis

NEWS.md

@@ -29,7 +29,8 @@ where the formatting is also better._
   `tinyplot(..., yaxl = "%")`, etc. More details are provided in the lower-level
   `tinylabel` function documentation (#363, #391 @grantmcdermott)
 
-### Bugs fixes:
+
+### Bug fixes:
 
 - The `tinyplot(..., cex = <cex>)` argument should be respected when using
   `type = "b"`. Thanks to @rjknell for report #307 and @vincentarelbundock for
@@ -70,6 +71,12 @@ where the formatting is also better._
 - Improved website theme and navigation layout, especially on mobile.
   (#395 @zeileis)
 
+### Misc:
+
+- Simplify specification of `xmin`/`xmax`/`ymin`/`ymax` in formula method.
+  The arguments are now processed along with the `model.frame()` so that
+  `ymin = var` works if `var` is a variable in the `data`.
+
 ### Internals:
 
 - The order of the nested loop for drawing interior plot elements has been

R/tinyplot.R

@@ -17,7 +17,8 @@
 #'   or interval plot types. Only used when the `type` argument is one of
 #'   `"rect"` or `"segments"` (where all four min-max coordinates are required),
 #'   or `"pointrange"`, `"errorbar"`, or `"ribbon"` (where only `ymin` and
-#'   `ymax` required alongside `x`).
+#'   `ymax` required alongside `x`). In the formula method the arguments
+#'   can be specified as `ymin = var` if `var` is a variable in `data`.
 #' @param by grouping variable(s). The default behaviour is for groups to be
 #'   represented in the form of distinct colours, which will also trigger an
 #'   automatic legend. (See `legend` below for customization options.) However,
@@ -1346,6 +1347,10 @@ tinyplot.formula = function(
     facet = NULL,
     facet.args = NULL,
     type = NULL,
+    xmin = NULL,
+    xmax = NULL,
+    ymin = NULL,
+    ymax = NULL,
     xlim = NULL,
     ylim = NULL,
     # log = "",
@@ -1384,12 +1389,18 @@ tinyplot.formula = function(
   ## placeholder for legend title
   legend_args = list(x = NULL)
 
+  ## turn facet into a formula if it does not evaluate successfully
+  if (inherits(try(facet, silent = TRUE), "try-error")) {
+    facet = as.formula(paste("~", deparse(substitute(facet))))
+    environment(facet) = environment(formula)
+  }
+
   ## process all formulas
   tf = tinyformula(formula, facet)
 
   ## set up model frame
   m = match.call(expand.dots = FALSE)
-  m = m[c(1L, match(c("formula", "data", "subset", "na.action", "drop.unused.levels"), names(m), 0L))]
+  m = m[c(1L, match(c("formula", "data", "subset", "na.action", "drop.unused.levels", "xmin", "xmax", "ymin", "ymax"), names(m), 0L))]
   m$formula = tf$full
   ## need stats:: for non-standard evaluation
   m[[1L]] = quote(stats::model.frame)
@@ -1459,6 +1470,10 @@ tinyplot.formula = function(
     facet = facet, facet.args = facet.args,
     data = data,
     type = type,
+    xmin = mf[["(xmin)"]],
+    xmax = mf[["(xmax)"]],
+    ymin = mf[["(ymin)"]],
+    ymax = mf[["(ymax)"]],
     xlim = xlim,
     ylim = ylim,
     # log = "",

R/type_errorbar.R

@@ -11,20 +11,11 @@
 #' op = tpar(pch = 19)
 #'  
 #' # "errorbar" and "pointrange" type convenience strings
-#' with(
-#'   coefs,
-#'   tinyplot(x = term, y = est, ymin = lwr, ymax = upr, type = "errorbar")
-#' )
-#' with(
-#'   coefs,
-#'   tinyplot(x = term, y = est, ymin = lwr, ymax = upr, type = "pointrange")
-#' )
+#' tinyplot(est ~ term, ymin = lwr, ymax = upr, data = coefs, type = "errorbar")
+#' tinyplot(est ~ term, ymin = lwr, ymax = upr, data = coefs, type = "pointrange")
 #' 
 #' # Use `type_errorbar()` to pass extra arguments for customization
-#' with(
-#'   coefs,
-#'   tinyplot(x = term, y = est, ymin = lwr, ymax = upr, type = type_errorbar(length = 0.2))
-#' )
+#' tinyplot(est ~ term, ymin = lwr, ymax = upr, data = coefs, type = type_errorbar(length = 0.2))
 #' 
 #' tpar(op)
 #' 

man/tinyplot.Rd

@@ -307,16 +307,14 @@ monthcoefs = data.frame(
   subset(!grepl("Day", term))
 
 # plot
-with(
-  monthcoefs,
-  tinyplot(
-    x = term, y = estimate,
-    ymin = ci_low, ymax = ci_high,
-    type = "pointrange", # or: "errobar", "ribbon"
-    pch = 19, col = "dodgerblue",
-    grid = TRUE,
-    main = "Average Monthly Effect on Temperature"
-  )
+tinyplot(
+  estimate ~ term,
+  ymin = ci_low, ymax = ci_high,
+  data = monthcoefs,
+  type = "pointrange", # or: "errobar", "ribbon"
+  pch = 19, col = "dodgerblue",
+  grid = TRUE,
+  main = "Average Monthly Effect on Temperature"
 )
 ```