Skip to content

Consolidate per-wrapper roxygen docs onto parent help pages #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yihui merged 4 commits into from
Apr 8, 2026
Merged

Consolidate per-wrapper roxygen docs onto parent help pages #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b136622
consolidate roxygen docs by component family using @rdname
Copilot Apr 8, 2026
a8ab326
Tidy @rdname wrapper docs: no title, @details fn() on same line, reus…
Copilot Apr 8, 2026
43375c8
Extract inline data.frame to named df in mark_line example
Copilot Apr 8, 2026
f0dc33d
Fix coord_theta example placement, verb consistency, blank+comment se…
Copilot Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 47 additions & 59 deletions R/component.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,14 @@ axis_ = function(chart = NULL, channel, ...) {
chart
}

#' Configure the X Axis
#'
#' @inheritParams axis_
#' @details `axis_x()`: Shortcut for `axis_(chart, 'x', ...)`.
#' @rdname axis_
#' @export
#' @examples
#' g2(mtcars, hp ~ mpg) |>
#' axis_x(title = 'Miles per Gallon')
axis_x = function(chart = NULL, ...) axis_(chart, 'x', ...)

#' Configure the Y Axis
#'
#' @inheritParams axis_
#' @details `axis_y()`: Shortcut for `axis_(chart, 'y', ...)`.
#' @rdname axis_
#' @export
#' @examples
#' g2(mtcars, hp ~ mpg) |>
#' axis_y(title = 'Horsepower')
axis_y = function(chart = NULL, ...) axis_(chart, 'y', ...)

#' Configure a Legend
Expand All @@ -69,8 +61,8 @@ axis_y = function(chart = NULL, ...) axis_(chart, 'y', ...)
#' @return The modified `g2` object.
#' @export
#' @examples
#' g2(iris, Sepal.Length ~ Sepal.Width, color = ~ Species) |>
#' legend_('color', position = 'right')
#' p = g2(iris, Sepal.Length ~ Sepal.Width, color = ~ Species)
#' p |> legend_('color', position = 'right')
legend_ = function(chart = NULL, channel, ...) {
mod = check_chart(legend_, chart, c(if (!missing(channel)) list(channel), list(...)))
if (!is.null(mod)) return(mod)
Expand All @@ -91,38 +83,41 @@ legend_ = function(chart = NULL, channel, ...) {
chart
}

#' Configure the Color Legend
#'
#' @inheritParams legend_
#' @details `legend_color()`: Shortcut for `legend_(chart, 'color', ...)`.
#' @rdname legend_
#' @export
#' @examples
#' g2(iris, Sepal.Length ~ Sepal.Width, color = ~ Species) |>
#' legend_color(position = 'right')
#'
#' # Color legend via shortcut
#' p |> legend_color(position = 'right')
legend_color = function(chart = NULL, ...) legend_(chart, 'color', ...)

#' Configure the Size Legend
#'
#' @inheritParams legend_
#' @details `legend_size()`: Shortcut for `legend_(chart, 'size', ...)`.
#' @rdname legend_
#' @export
#' @examples
#'
#' # Size legend
#' g2(mtcars, hp ~ mpg, size = ~ wt) |>
#' legend_size(position = 'bottom')
legend_size = function(chart = NULL, ...) legend_(chart, 'size', ...)

#' Configure the Shape Legend
#'
#' @inheritParams legend_
#' @details `legend_shape()`: Shortcut for `legend_(chart, 'shape', ...)`.
#' @rdname legend_
#' @export
#' @examples
#' g2(iris, Sepal.Length ~ Sepal.Width, shape = ~ Species) |>
#' legend_shape(position = 'bottom')
#'
#' # Shape legend
#' p = g2(iris, Sepal.Length ~ Sepal.Width, shape = ~ Species)
#' p |> legend_shape(position = 'bottom')
legend_shape = function(chart = NULL, ...) legend_(chart, 'shape', ...)

#' Configure the Opacity Legend
#'
#' @inheritParams legend_
#' @details `legend_opacity()`: Shortcut for `legend_(chart, 'opacity', ...)`.
#' @rdname legend_
#' @export
#' @examples
#'
#' # Opacity legend
#' g2(mtcars, hp ~ mpg, opacity = ~ wt) |>
#' legend_opacity(position = 'bottom')
legend_opacity = function(chart = NULL, ...) legend_(chart, 'opacity', ...)
Expand Down Expand Up @@ -228,8 +223,8 @@ style_mark = function(chart = NULL, ...) {
#' @return The modified `g2` object.
#' @export
#' @examples
#' g2(mtcars, hp ~ mpg) |>
#' slider_('x')
#' p = g2(mtcars, hp ~ mpg)
#' p |> slider_('x')
slider_ = function(chart = NULL, channel, ...) {
mod = check_chart(slider_, chart, c(if (!missing(channel)) list(channel), list(...)))
if (!is.null(mod)) return(mod)
Expand All @@ -239,36 +234,35 @@ slider_ = function(chart = NULL, channel, ...) {
chart
}

#' Add an X Slider
#'
#' @inheritParams slider_
#' @details `slider_x()`: Shortcut for `slider_(chart, 'x', ...)`.
#' @rdname slider_
#' @export
#' @examples
#' g2(mtcars, hp ~ mpg) |>
#' slider_x()
#'
#' # Slider shortcuts
#' p |> slider_x()
slider_x = function(chart = NULL, ...) slider_(chart, 'x', ...)

#' Add a Y Slider
#'
#' @inheritParams slider_
#' @details `slider_y()`: Shortcut for `slider_(chart, 'y', ...)`.
#' @rdname slider_
#' @export
#' @examples
#' g2(mtcars, hp ~ mpg) |>
#' slider_y()
#' p |> slider_y()
slider_y = function(chart = NULL, ...) slider_(chart, 'y', ...)

#' Add a Scrollbar
#'
#' Add a scrollbar to a positional channel for zooming/panning.
#'
#' @param chart A `g2` object.
#' @param channel Positional channel: `'x'` or `'y'`.
#' @param ... Scrollbar options.
#' @return The modified `g2` object.
#' @export
#' @examples
#' df = data.frame(x = 1:100, y = cumsum(rnorm(100)))
#' g2(df, y ~ x) |>
#' mark_line() |>
#' scrollbar_('x')
#' p = g2(df, y ~ x) |> mark_line()
#' p |> scrollbar_('x')
scrollbar_ = function(chart = NULL, channel, ...) {
mod = check_chart(scrollbar_, chart, c(if (!missing(channel)) list(channel), list(...)))
if (!is.null(mod)) return(mod)
Expand All @@ -278,24 +272,18 @@ scrollbar_ = function(chart = NULL, channel, ...) {
chart
}

#' Add an X Scrollbar
#'
#' @inheritParams scrollbar_
#' @details `scrollbar_x()`: Shortcut for `scrollbar_(chart, 'x', ...)`.
#' @rdname scrollbar_
#' @export
#' @examples
#' df = data.frame(x = 1:100, y = cumsum(rnorm(100)))
#' g2(df, y ~ x) |>
#' mark_line() |>
#' scrollbar_x()
#'
#' # Scrollbar shortcuts
#' p |> scrollbar_x()
scrollbar_x = function(chart = NULL, ...) scrollbar_(chart, 'x', ...)

#' Add a Y Scrollbar
#'
#' @inheritParams scrollbar_
#' @details `scrollbar_y()`: Shortcut for `scrollbar_(chart, 'y', ...)`.
#' @rdname scrollbar_
#' @export
#' @examples
#' df = data.frame(x = 1:100, y = cumsum(rnorm(100)))
#' g2(df, y ~ x) |>
#' mark_line() |>
#' scrollbar_y()
#' p |> scrollbar_y()
scrollbar_y = function(chart = NULL, ...) scrollbar_(chart, 'y', ...)
77 changes: 24 additions & 53 deletions R/coordinate.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,17 @@
#' @return The modified `g2` object.
#' @export
#' @examples
#' # Polar coordinate (rose chart)
#' df = data.frame(x = c('A', 'B', 'C'), y = c(3, 7, 2))
#' g2(df, y ~ x) |>
#' coord_polar()
#' p = g2(df, y ~ x, color = ~ x)
#' # Polar coordinate (rose chart)
#' g2(df, y ~ x) |> coord_polar()
#'
#' # Theta coordinate (pie / donut chart)
#' g2(df, y ~ x, color = ~ x) |>
#' transform_('stackY') |>
#' coord_theta()
#' p |> transform_('stackY') |> coord_theta()
#' p |> transform_('stackY') |> coord_theta(innerRadius = 0.5)
#'
#' # Radial coordinate (radial bar chart)
#' g2(df, y ~ x, color = ~ x) |>
#' coord_radial()
#' p |> coord_radial()
#'
#' # Parallel coordinate (uses position encoding)
#' g2(iris, position = names(iris)[-5], color = ~ Species,
Expand Down Expand Up @@ -68,7 +66,8 @@ coord_ = function(chart = NULL, type, ...) {
#' @export
#' @examples
#' # Horizontal bar chart (coord_flip equivalent)
#' g2(data.frame(x = c('A', 'B', 'C'), y = c(3, 7, 2)), y ~ x) |>
#' df = data.frame(x = c('A', 'B', 'C'), y = c(3, 7, 2))
#' g2(df, y ~ x) |>
#' coord_transpose()
coord_transpose = function(chart = NULL) {
mod = check_chart(coord_transpose, chart, list())
Expand All @@ -81,64 +80,36 @@ coord_transpose = function(chart = NULL) {
chart
}

#' Polar Coordinate System
#'
#' Shortcut for `coord_(chart, 'polar', ...)`.
#'
#' @inheritParams coord_
#' @details `coord_polar()`: Shortcut for `coord_(chart, 'polar', ...)`.
#' @rdname coord_
#' @export
#' @examples
#' g2(data.frame(x = c('A', 'B', 'C'), y = c(3, 7, 2)), y ~ x, color = ~ x) |>
#' coord_polar()
coord_polar = function(chart = NULL, ...) coord_(chart, 'polar', ...)

#' Theta Coordinate System
#'
#' Shortcut for `coord_(chart, 'theta', ...)`. Used for pie and donut
#' charts.
#'
#' @inheritParams coord_
#' @details `coord_theta()`: Shortcut for `coord_(chart, 'theta', ...)`. Used for
#' pie and donut charts.
#' @rdname coord_
#' @export
#' @examples
#' g2(data.frame(x = c('A', 'B', 'C'), y = c(3, 7, 2)), y ~ x, color = ~ x) |>
#' transform_('stackY') |>
#' coord_theta(innerRadius = 0.5)
coord_theta = function(chart = NULL, ...) coord_(chart, 'theta', ...)

#' Radial Coordinate System
#'
#' Shortcut for `coord_(chart, 'radial', ...)`. Suitable for radial bar
#' charts.
#'
#' @inheritParams coord_
#' @details `coord_radial()`: Shortcut for `coord_(chart, 'radial', ...)`. Suitable
#' for radial bar charts.
#' @rdname coord_
#' @export
#' @examples
#' g2(data.frame(x = c('A', 'B', 'C'), y = c(3, 7, 2)), y ~ x, color = ~ x) |>
#' coord_radial()
coord_radial = function(chart = NULL, ...) coord_(chart, 'radial', ...)

#' Radar Coordinate System
#'
#' Shortcut for `coord_(chart, 'radar', ...)`. Used with `position`
#' encoding for radar (spider) charts.
#'
#' @inheritParams coord_
#' @details `coord_radar()`: Shortcut for `coord_(chart, 'radar', ...)`. Used with
#' `position` encoding for radar (spider) charts.
#' @rdname coord_
#' @export
coord_radar = function(chart = NULL, ...) coord_(chart, 'radar', ...)

#' Helix Coordinate System
#'
#' Shortcut for `coord_(chart, 'helix', ...)`.
#'
#' @inheritParams coord_
#' @details `coord_helix()`: Shortcut for `coord_(chart, 'helix', ...)`.
#' @rdname coord_
#' @export
coord_helix = function(chart = NULL, ...) coord_(chart, 'helix', ...)

#' Parallel Coordinate System
#'
#' Shortcut for `coord_(chart, 'parallel', ...)`. Used with `position`
#' encoding for parallel coordinate plots.
#'
#' @inheritParams coord_
#' @details `coord_parallel()`: Shortcut for `coord_(chart, 'parallel', ...)`. Used
#' with `position` encoding for parallel coordinate plots.
#' @rdname coord_
#' @export
coord_parallel = function(chart = NULL, ...) coord_(chart, 'parallel', ...)
Loading
Loading