[change] default (h)boxplot width to ratio (#175)

Author: Mc-Zen

src/plot/boxplot.typ

@@ -4,6 +4,7 @@
 #import "../style/styling.typ": mark, prepare-mark
 #import "../logic/time.typ"
 #import "../math.typ": minmax
+#import "../process-styles.typ": process-plot-item-width
 
 
 #let render-boxplot(plot, transform) = {
@@ -196,10 +197,9 @@
   /// -> int | float
   whisker-pos: 1.5,
 
-  /// The width of the boxplots in $x$ data coordinates. This can be a constant width
-  /// applied to all boxplots or an array of widths matching the number of data sets. 
-  /// -> int | float | array
-  width: 0.5,
+  /// The width of the boxplots in $x$ data coordinates. See @bar.width.
+  /// -> ratio | int | float | duration | array
+  width: 50%,
 
   /// How to fill the boxes. 
   /// -> none | color | gradient | tiling
@@ -272,8 +272,11 @@
   data = data.pos()
   let num-boxplots = data.len()
 
-  if type(x) in (int, float, datetime) { x = (x,) }
-  else if x == auto { x = range(1, num-boxplots + 1) }
+  if x == auto {
+    x = range(1, num-boxplots + 1)
+  } else if type(x) != array {
+    x = (x,)
+  }
 
   let datetime-axes = (:)
   if type(x.at(0, default: 0)) == datetime {
@@ -285,8 +288,10 @@
     x.len() == num-boxplots, 
     message: "The number of x coordinates does not match the number of data arrays"
   )
+
+  
+  width = process-plot-item-width(width, x)
 
-  if type(width) in (int, float) { width = (width,) * num-boxplots }
   assert(
     width.len() == num-boxplots, 
     message: "The number of widths does not match the number of data arrays"

src/plot/hboxplot.typ

@@ -4,6 +4,7 @@
 #import "../style/styling.typ": mark, prepare-mark
 #import "../logic/time.typ"
 #import "../math.typ": minmax
+#import "../process-styles.typ": process-plot-item-width
 
 
 #let render-boxplot(plot, transform) = {
@@ -154,10 +155,9 @@
   /// -> int | float
   whisker-pos: 1.5,
 
-  /// The width of the boxplots in $y$ data coordinates. This can be a constant width
-  /// applied to all boxplots or an array of widths matching the number of data sets. 
-  /// -> int | float | array
-  width: 0.5,
+  /// The width of the boxplots in $y$ data coordinates. See @bar.width.
+  /// -> ratio | int | float | duration | array
+  width: 50%,
 
   /// How to fill the boxes. 
   /// -> none | color | gradient | tiling
@@ -224,8 +224,11 @@
   data = data.pos()
   let num-boxplots = data.len()
 
-  if type(y) in (int, float) { y = (y,) }
-  else if y == auto { y = range(1, num-boxplots + 1) }
+  if y == auto {
+    y = range(1, num-boxplots + 1)
+  } else if type(y) != array {
+    y = (y,)
+  }
 
   let datetime-axes = (:)
   if type(y.at(0, default: 0)) == datetime {
@@ -237,7 +240,7 @@
     message: "The number of y coordinates does not match the number of data arrays"
   )
 
-  if type(width) in (int, float) { width = (width,) * num-boxplots }
+  width = process-plot-item-width(width, y)
   assert(
     width.len() == num-boxplots, 
     message: "The number of widths does not match the number of data arrays"

src/plot/hviolin.typ

@@ -149,8 +149,10 @@
   data = data.pos()
   let num-violins = data.len()
 
-  if type(y) in (int, float, datetime) { y = (y,) } else if y == auto {
+  if y == auto {
     y = range(1, num-violins + 1)
+  } else if type(y) != array {
+    y = (y,)
   }
 
   let datetime-axes = (:)

src/plot/violin.typ

@@ -495,8 +495,10 @@
   data = data.pos()
   let num-violins = data.len()
 
-  if type(x) in (int, float, datetime) { x = (x,) } else if x == auto {
+  if x == auto {
     x = range(1, num-violins + 1)
+  } else if type(x) != array {
+    x = (x,)
   }
 
   let datetime-axes = (:)

tests/plot/boxplot/ref/7.png

@@ -26,21 +26,21 @@
     range(4),
     (
       median: 2.5,
-      q1: 1, 
-      q3: 3, 
-      whisker-low: 0, 
-      whisker-high: 10, 
+      q1: 1,
+      q3: 3,
+      whisker-low: 0,
+      whisker-high: 10,
     ),
     (
       median: 7,
-      q1: 3, 
-      q3: 8, 
-      whisker-low: 2, 
-      whisker-high: 10, 
-      outliers: (0, 1)
+      q1: 3,
+      q3: 8,
+      whisker-low: 2,
+      whisker-high: 10,
+      outliers: (0, 1),
     ),
-    x: (1, 2, 4)
-  )
+    x: (1, 2, 4),
+  ),
 )
 
 
@@ -64,8 +64,8 @@
     outliers: "s",
     outlier-size: 2pt,
     outlier-fill: green,
-    outlier-stroke: .5pt + black
-  )
+    outlier-stroke: .5pt + black,
+  ),
 )
 
 
@@ -78,13 +78,13 @@
 #lq.diagram(
   lq.boxplot(
     (1, 2, 3, 7, 8),
-    mean: "x"
+    mean: "x",
   ),
   lq.boxplot(
     (1, 2, 3, 7, 8),
     mean: green + 1pt,
-    x: 2
-  )
+    x: 2,
+  ),
 )
 
 
@@ -96,9 +96,9 @@
 
 #lq.diagram(
   lq.boxplot(
-    (1, 3, 4, 5, 6, 3, 1, 72, 3, 7, 8, 10,11, 34),
+    (1, 3, 4, 5, 6, 3, 1, 72, 3, 7, 8, 10, 11, 34),
     whisker-pos: 6,
-  )
+  ),
 )
 
 
@@ -116,4 +116,37 @@
     (0, 4, 5, 6),
     (-1, 0, 9, 10),
   ),
-)
+)
+
+#pagebreak()
+
+
+// Datetime x and ratio/duration width
+#lq.diagram(
+  lq.boxplot(
+    (1, 2),
+    (1, 2),
+    x: (
+      datetime(year: 2025, month: 2, day: 1),
+      datetime(year: 2025, month: 3, day: 1),
+    ),
+    width: 80%,
+  ),
+  lq.boxplot(
+    (1, 2),
+    x: datetime(year: 2025, month: 4, day: 1),
+    width: duration(weeks: 4),
+  ),
+  lq.boxplot(
+    (1, 2),
+    (1, 2),
+    x: (
+      datetime(year: 2025, month: 5, day: 1),
+      datetime(year: 2025, month: 6, day: 1),
+    ),
+    width: (
+      duration(weeks: 2),
+      duration(weeks: 1),
+    ),
+  ),
+)

tests/plot/boxplot/test.typ

@@ -26,21 +26,21 @@
     range(4),
     (
       median: 2.5,
-      q1: 1, 
-      q3: 3, 
-      whisker-low: 0, 
-      whisker-high: 10, 
+      q1: 1,
+      q3: 3,
+      whisker-low: 0,
+      whisker-high: 10,
     ),
     (
       median: 7,
-      q1: 3, 
-      q3: 8, 
-      whisker-low: 2, 
-      whisker-high: 10, 
-      outliers: (0, 1)
+      q1: 3,
+      q3: 8,
+      whisker-low: 2,
+      whisker-high: 10,
+      outliers: (0, 1),
     ),
-    y: (1, 2, 4)
-  )
+    y: (1, 2, 4),
+  ),
 )
 
 
@@ -64,8 +64,8 @@
     outliers: "s",
     outlier-size: 2pt,
     outlier-fill: green,
-    outlier-stroke: .5pt + black
-  )
+    outlier-stroke: .5pt + black,
+  ),
 )
 
 
@@ -78,13 +78,13 @@
 #lq.diagram(
   lq.hboxplot(
     (1, 2, 3, 7, 8),
-    mean: "x"
+    mean: "x",
   ),
   lq.hboxplot(
     (1, 2, 3, 7, 8),
     mean: green + 1pt,
-    y: 2
-  )
+    y: 2,
+  ),
 )
 
 
@@ -96,9 +96,9 @@
 
 #lq.diagram(
   lq.hboxplot(
-    (1, 3, 4, 5, 6, 3, 1, 72, 3, 7, 8, 10,11, 34),
+    (1, 3, 4, 5, 6, 3, 1, 72, 3, 7, 8, 10, 11, 34),
     whisker-pos: 6,
-  )
+  ),
 )
 
 #pagebreak()
@@ -114,4 +114,37 @@
     (0, 4, 5, 6),
     (-1, 0, 9, 10),
   ),
-)
+)
+
+#pagebreak()
+
+
+// Datetime x and ratio/duration width
+#lq.diagram(
+  lq.hboxplot(
+    (1, 2),
+    (1, 2),
+    y: (
+      datetime(year: 2025, month: 2, day: 1),
+      datetime(year: 2025, month: 3, day: 1),
+    ),
+    width: 80%,
+  ),
+  lq.hboxplot(
+    (1, 2),
+    y: datetime(year: 2025, month: 4, day: 1),
+    width: duration(weeks: 4),
+  ),
+  lq.hboxplot(
+    (1, 2),
+    (1, 2),
+    y: (
+      datetime(year: 2025, month: 5, day: 1),
+      datetime(year: 2025, month: 6, day: 1),
+    ),
+    width: (
+      duration(weeks: 2),
+      duration(weeks: 1),
+    ),
+  ),
+)