Fix broken coordinate/mark examples, dark themes, add missing marks, add padding_of()

R/coordinate.R

@@ -6,6 +6,9 @@
 #' transforms such as `'transpose'` (equivalent to ggplot2's `coord_flip()`) or
 #' `'fisheye'`.
 #'
+#' The `'radar'` and `'parallel'` coordinates require a `position` encoding
+#' (a character vector of column names) instead of separate `x`/`y` encodings.
+#'
 #' @param chart A `g2` object.
 #' @param type Coordinate type string.
 #' @param ... Additional options such as `innerRadius`, `outerRadius`,
@@ -30,11 +33,19 @@
 #'   mark_interval() |>
 #'   coordinate('radial')
 #'
-#' # Parallel coordinate
+#' # Parallel coordinate (uses position encoding)
 #' g2(iris, position = c('Sepal.Length', 'Sepal.Width',
 #'     'Petal.Length', 'Petal.Width'), color = 'Species') |>
-#'   mark_line(transform = list(list(type = 'normalizeY'))) |>
+#'   mark_line() |>
 #'   coordinate('parallel')
+#'
+#' # Radar coordinate (uses position encoding)
+#' df2 = data.frame(item = c('A', 'B', 'C', 'D', 'E'),
+#'   score = c(3, 7, 2, 5, 4))
+#' g2(df2, position = c('item', 'score')) |>
+#'   mark_line(style = list(closed = TRUE)) |>
+#'   mark_point() |>
+#'   coordinate('radar')
 coordinate = function(chart, type, ...) {
   chart$coords = c(list(type = type), list(...))
   chart

R/mark.R

@@ -248,16 +248,12 @@ mark_boxplot = function(chart, ...) mark(chart, 'boxplot', ...)
 
 #' Add a Density Mark
 #'
-#' A composite mark for kernel density estimation visualization.
+#' A composite mark for kernel density estimation visualization. Note that
+#' G2 v5 does not support the `kde` transform; use [mark_heatmap()] as an
+#' alternative for 2-D density visualizations.
 #'
 #' @inheritParams mark
 #' @export
-#' @examples
-#' g2(iris, x = 'Sepal.Width', y = 'Sepal.Length') |>
-#'   mark_density(
-#'     transform = list(list(type = 'kde')),
-#'     style = list(fill = 'steelblue', fillOpacity = 0.5)
-#'   )
 mark_density = function(chart, ...) mark(chart, 'density', ...)
 
 #' Add a Heatmap Mark
@@ -435,21 +431,9 @@ mark_shape = function(chart, ...) mark(chart, 'shape', ...)
 
 #' Add a Partition (Sunburst) Mark
 #'
+#' Note: the `partition` mark may not work correctly in G2 v5. Consider using
+#' [mark_treemap()] as an alternative for hierarchical data visualization.
+#'
 #' @inheritParams mark
 #' @export
-#' @examples
-#' tree_data = list(
-#'   name = 'root', children = list(
-#'     list(name = 'A', value = 10, children = list(
-#'       list(name = 'A1', value = 5), list(name = 'A2', value = 5)
-#'     )),
-#'     list(name = 'B', value = 20)
-#'   )
-#' )
-#' g2() |>
-#'   mark_partition(
-#'     data = list(value = tree_data),
-#'     encode = list(value = 'value'),
-#'     coordinate = list(type = 'theta', innerRadius = 0.3)
-#'   )
 mark_partition = function(chart, ...) mark(chart, 'partition', ...)

examples/coordinates.Rmd

@@ -86,6 +86,45 @@ g2(df, x = 'x', y = 'y', color = 'x') |>
   coordinate('radial', innerRadius = 0.3)
 ```
 
+## Parallel
+
+Maps multiple numeric variables to parallel axes. Use a `position`
+encoding (a character vector of column names) instead of `x`/`y`.
+
+```{r}
+g2(iris, position = c('Sepal.Length', 'Sepal.Width',
+    'Petal.Length', 'Petal.Width'), color = 'Species') |>
+  mark_line() |>
+  coordinate('parallel')
+```
+
+## Radar
+
+Displays data on radial axes emanating from a center point. Like
+parallel coordinates, radar charts require a `position` encoding.
+
+```{r}
+df_radar = data.frame(
+  item = c('A', 'B', 'C', 'D', 'E'),
+  score = c(3, 7, 2, 5, 4)
+)
+g2(df_radar, position = c('item', 'score')) |>
+  mark_line(style = list(closed = TRUE)) |>
+  mark_point() |>
+  coordinate('radar')
+```
+
+## Helix
+
+Arranges data along a helix spiral.
+
+```{r}
+df_helix = data.frame(x = 1:50, y = sin(1:50 / 5))
+g2(df_helix, x = 'x', y = 'y') |>
+  mark_line() |>
+  coordinate('helix')
+```
+
 ## Transpose (coord_flip)
 
 Swap x and y axes, equivalent to ggplot2's `coord_flip()`. This is a