Support lwd argument

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: tinyplot
 Type: Package
 Title: Lightweight Extension of the Base R Graphics System
-Version: 0.0.5.9001
+Version: 0.0.5.9002
 Authors@R: 
   c(
     person(

NEWS.md

@@ -1,6 +1,6 @@
 # News
 
-## 0.0.5.9001 (development version)
+## 0.0.5.9002 (development version)
 
 New features:
 
@@ -13,6 +13,10 @@ final implementation. (#122 @grantmcdermott)
 - Ordered factors now inherit a discrete sequential color palette ("viridis") by
 default. Thanks to @zeileis for the suggestion. (#130 @grantmcdermott)
 - Support user-supplied polygons. (#127 @grantmcdermott)
+- Support for the `lwd` argument for adjusting line widths. Similar to `pch`,
+`lty`, etc. this arguments also accepts a "by" convenience keyword to
+automatically vary line widths by group. (#134 @grantmcdermott)
+
 
 ## 0.0.5
 

R/by_aesthetics.R

@@ -165,7 +165,7 @@ by_pch = function(ngrps, type, pch=NULL) {
 
 by_lty = function(ngrps, type, lty=NULL) {
 
-  # don't care about line type, return NULL
+  # We only care about line types, otherwise return NULL
   if (!type %in% c("l", "b", "o", "c", "h", "s", "S", "ribbon")) {
     out = NULL
 
@@ -212,4 +212,33 @@ by_lty = function(ngrps, type, lty=NULL) {
   }
 
   return(out)
-}
+}
+
+
+by_lwd = function(ngrps, type, lwd=NULL) {
+
+  lwd_base = par("lwd")
+  lwd_floor = lwd_base / min(5, max((ngrps-1), 1))
+  lwd_ceiling = lwd_base * min(5, ngrps)
+
+  no_lwd = FALSE
+  # special "by" convenience keyword
+  if (!is.null(lwd) && length(lwd)==1 && lwd=="by") {
+    no_lwd = TRUE # skip checks below
+    lwd = seq(lwd_floor, lwd_ceiling, length.out = ngrps)
+  } else if (is.null(lwd)) {
+    no_lwd = TRUE
+    lwd = NULL
+  }
+
+  if (!no_lwd) {
+    if (!is.atomic(lwd) || !is.vector(lwd) || !is.numeric(lwd) || (length(lwd) != 1 && length(lwd) != ngrps)) {
+      stop(sprintf("`lwd` must be `NULL` or a numeric vector of length 1 or %s.", ngrps), call. = FALSE)
+    }
+    if (length(lwd) == 1) {
+      lwd = rep(lwd, ngrps)
+    }
+  }
+
+  return(lwd)
+}

R/draw_legend.R

@@ -11,6 +11,7 @@
 #' @param type Plotting type(s), passed down from `tinyplot`.
 #' @param pch Plotting character(s), passed down from `tinyplot`.
 #' @param lty Plotting linetype(s), passed down from `tinyplot`.
+#' @param lwd Plotting line width(s), passed down from `tinyplot`.
 #' @param col Plotting colour(s), passed down from `tinyplot`.
 #' @param bg Plotting character background fill colour(s), passed down from `tinyplot`.
 #' @param cex Plotting character expansion(s), passed down from `tinyplot`.
@@ -96,6 +97,7 @@ draw_legend = function(
     type = NULL,
     pch = NULL,
     lty = NULL,
+    lwd = NULL,
     col = NULL,
     bg = NULL,
     cex = NULL,
@@ -142,6 +144,9 @@ draw_legend = function(
   if (!exists("title", where = legend_args)) legend_args[["title"]] = by_dep
   if (is.null(legend_args[["pch"]])) legend_args[["pch"]] = pch
   if (is.null(legend_args[["lty"]])) legend_args[["lty"]] = lty
+  if (!is.null(type) && !(type %in% c("p", "ribbon", "polygon"))) {
+    if (is.null(legend_args[["lwd"]])) legend_args[["lwd"]] = lwd
+  }
   if (is.null(legend_args[["col"]])) legend_args[["col"]] = col
   if (is.null(legend_args[["bty"]])) legend_args[["bty"]] = "n"
   if (is.null(legend_args[["horiz"]])) legend_args[["horiz"]] = FALSE

R/tinyplot.R

@@ -148,7 +148,7 @@
 #'   be necessary unless users wish to override the automatic colors produced by
 #'   this grouping process. Typically, this would only be done if grouping
 #'   features are deferred to some other graphical parameter (i.e., passing the
-#'   "by" keyword to one of `pch`, `lty`, or `bg`; see below.)
+#'   "by" keyword to one of `pch`, `lty`, `lwd`, or `bg`; see below.)
 #' @param pch plotting "character", i.e., symbol to use. Character, integer, or
 #'   vector of length equal to the number of categories in the `by` variable.
 #'   See `pch`. In addition, users can supply a special `pch = "by"` convenience
@@ -161,6 +161,12 @@
 #'   line type will automatically loop over the number groups. This automatic
 #'   looping will begin at the global line type value (i.e., `par("lty")`) and
 #'   recycle as necessary.
+#' @param lwd line width. Numeric scalar or vector of length equal to the
+#'   number of categories in the `by` variable. See `lwd`. In addition, users
+#'   can supply a special `lwd = "by"` convenience argument, in which case the
+#'   line width will automatically loop over the number of groups. This
+#'   automatic looping will be centered at the global line width value (i.e.,
+#`   par("lwd")`) and pad on either side of that.
 #' @param bg background fill color for the open plot symbols 21:25 (see
 #'   `points.default`), as well as ribbon and area plot types. For the latter
 #'   group---including filled density plots---an automatic alpha transparency
@@ -394,6 +400,7 @@ tinyplot.default = function(
     legend = NULL,
     pch = NULL,
     lty = NULL,
+    lwd = NULL,
     col = NULL,
     bg = NULL,
     fill = NULL,
@@ -563,6 +570,8 @@ tinyplot.default = function(
   pch = by_pch(ngrps = ngrps, type = type, pch = pch)
 
   lty = by_lty(ngrps = ngrps, type = type, lty = lty)
+
+  lwd = by_lwd(ngrps = ngrps, type = type, lwd = lwd)
 
   # palette = substitute(palette)
   col = by_col(
@@ -724,6 +733,7 @@ tinyplot.default = function(
       type = type,
       pch = pch,
       lty = lty,
+      lwd = lwd,
       col = col,
       bg = bg,
       gradient = by_continuous,
@@ -1120,6 +1130,7 @@ tinyplot.default = function(
     ibg = bg[i]
     ipch = pch[i]
     ilty = lty[i]
+    ilwd = lwd[i]
 
     ## Inner loop over the "facet" variables
     for (ii in seq_along(idata)) {
@@ -1163,7 +1174,8 @@ tinyplot.default = function(
           x1 = xx,
           y1 = yymax,
           col = icol,
-          lty = ilty
+          # lty = ilty,
+          lwd = ilwd
         )
       }
       if (type == "errorbar") {
@@ -1173,7 +1185,8 @@ tinyplot.default = function(
           x1 = xx,
           y1 = yymax,
           col = icol,
-          lty = ilty,
+          # lty = ilty,
+          lwd = ilwd,
           length = 0.05,
           angle = 90,
           code = 3
@@ -1190,7 +1203,8 @@ tinyplot.default = function(
           ## rather hardcode "p" to avoid warning message about "pointrange"
           type = "p",
           pch = ipch,
-          lty = ilty,
+          # lty = ilty,
+          lwd = ilwd,
           cex = cex
         )
       } else if (type %in% c("l", "o", "b", "c", "h", "s", "S", "ribbon")) {
@@ -1202,7 +1216,8 @@ tinyplot.default = function(
           col = icol,
           type = type,
           pch = ipch,
-          lty = ilty
+          lty = ilty,
+          lwd = ilwd
         )
         if (rtype) type = "ribbon"
       } else if (type == "polygon") {
@@ -1212,6 +1227,7 @@ tinyplot.default = function(
           border = icol,
           col = ibg,
           lty = ilty,
+          lwd = ilwd
         )
       } else {
         stop("`type` argument not supported.", call. = FALSE)
@@ -1255,6 +1271,7 @@ tinyplot.formula = function(
     pch = NULL,
     col = NULL,
     lty = NULL,
+    lwd = NULL,
     par_restore = FALSE,
     formula = NULL,
     subset = NULL,
@@ -1432,6 +1449,7 @@ tinyplot.formula = function(
     pch = pch,
     col = col,
     lty = lty,
+    lwd = lwd,
     par_restore = par_restore,
     ...
     )
@@ -1463,6 +1481,7 @@ tinyplot.density = function(
     pch = NULL,
     col = NULL,
     lty = NULL,
+    lwd = NULL,
     bg = NULL,
     fill = NULL,
     par_restore = FALSE,
@@ -1636,6 +1655,7 @@ tinyplot.density = function(
     bg = bg,
     fill = fill,
     lty = lty,
+    lwd = lwd,
     par_restore = par_restore,
     ...
     )