Skip to content

Commit

Permalink
doc: fix cross references
Browse files Browse the repository at this point in the history
  • Loading branch information
davidgohel committed Nov 19, 2024
1 parent 1b4a8a9 commit f2b5422
Show file tree
Hide file tree
Showing 102 changed files with 288 additions and 281 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ URL: https://davidgohel.github.io/ggiraph/
BugReports: https://github.com/davidgohel/ggiraph/issues
Imports:
cli,
ggplot2 (>= 3.5.0),
ggplot2 (>= 3.5.1),
grid,
htmltools,
htmlwidgets (>= 1.5),
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Issues

- enable build in Alpine linux, thanks to Sebastian Meyer.
- geom_line_interactive now correctly assigns data_id and tooltip values
- `geom_line_interactive()` now correctly assigns data_id and tooltip values

## Changes

Expand Down
2 changes: 1 addition & 1 deletion R/annotate_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive annotations
#'
#' @description
#' The layer is based on [annotate()].
#' The layer is based on [ggplot2::annotate()].
#' See the documentation for that function for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/annotation_raster_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive raster annotations
#'
#' @description
#' The layer is based on [annotation_raster()].
#' The layer is based on [ggplot2::annotation_raster()].
#' See the documentation for that function for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
6 changes: 3 additions & 3 deletions R/element_interactive.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
#' With these functions the user can add interactivity to various [theme][ggplot2::theme]
#' elements.
#'
#' They are based on [element_rect()],
#' [element_line()] and [element_text()]
#' They are based on [ggplot2::element_rect()],
#' [ggplot2::element_line()] and [ggplot2::element_text()]
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down Expand Up @@ -63,7 +63,7 @@ element_interactive <- function(element_func,
#' @title Create an interactive label
#' @description
#' This function returns an object that can be used as a label
#' via the [labs()] family of functions or
#' via the [ggplot2::labs()] family of functions or
#' when setting a `scale`/`guide` name/title or key label.
#' It passes the interactive parameters to a theme element created via
#' [element_text_interactive()] or via an interactive guide.
Expand Down
4 changes: 2 additions & 2 deletions R/facet_interactive.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

#' @title Create interactive wraped facets
#' @description These facets are based on
#' [facet_wrap()].
#' [ggplot2::facet_wrap()].
#'
#' To make a facet interactive, it is mandatory to use
#' [labeller_interactive()] for argument `labeller`.
Expand Down Expand Up @@ -51,7 +51,7 @@ FacetInteractiveWrap <- ggproto("FacetInteractiveWrap", FacetWrap,

#' @title Create interactive grid facets
#' @description These facets are based on
#' [facet_grid()].
#' [ggplot2::facet_grid()].
#'
#' To make a facet interactive, it is mandatory to use
#' [labeller_interactive()] for argument `labeller`.
Expand Down
4 changes: 2 additions & 2 deletions R/geom_abline_interactive.R
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#' @title Create interactive reference lines
#'
#' @description
#' These geometries are based on [geom_abline()],
#' [geom_hline()] and [geom_vline()].
#' These geometries are based on [ggplot2::geom_abline()],
#' [ggplot2::geom_hline()] and [ggplot2::geom_vline()].
#'
#' @param ... arguments passed to base function,
#' plus any of the [interactive_parameters].
Expand Down
8 changes: 4 additions & 4 deletions R/geom_bar_interactive.R
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#' @title Create interactive bars
#'
#' @description
#' The geometries are based on [geom_bar()]
#' and [geom_col()].
#' The geometries are based on [ggplot2::geom_bar()]
#' and [ggplot2::geom_col()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand All @@ -27,8 +27,8 @@ GeomInteractiveBar <- ggproto(
default_aes = add_default_interactive_aes(GeomBar),
parameters = interactive_geom_parameters,
draw_key = interactive_geom_draw_key,
draw_panel = function(self, data, panel_params, coord,
width = NULL, flipped_aes = FALSE,
draw_panel = function(self, data, panel_params, coord,
width = NULL, flipped_aes = FALSE,
.ipar = IPAR_NAMES) {
GeomInteractiveRect$draw_panel(data, panel_params, coord, .ipar = .ipar)
}
Expand Down
2 changes: 1 addition & 1 deletion R/geom_bin_2d_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive heatmaps of 2d bin counts
#'
#' @description
#' The geometry is based on [geom_bin_2d()].
#' The geometry is based on [ggplot2::geom_bin_2d()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_boxplot_interactive.R
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ StatInteractiveBoxplot <- ggproto(
#' @title Create interactive boxplot
#'
#' @description
#' The geometry is based on [geom_boxplot()].
#' The geometry is based on [ggplot2::geom_boxplot()].
#' See the documentation for that function for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
4 changes: 2 additions & 2 deletions R/geom_contour_interactive.R
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#' @title Create interactive 2d contours of a 3d surface
#'
#' @description
#' These geometries are based on [geom_contour()]
#' and [geom_contour_filled()].
#' These geometries are based on [ggplot2::geom_contour()]
#' and [ggplot2::geom_contour_filled()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_count_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive point counts
#'
#' @description
#' The geometry is based on [geom_bin2d()].
#' The geometry is based on [ggplot2::geom_bin2d()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
4 changes: 2 additions & 2 deletions R/geom_crossbar_interactive.R
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#' Create interactive vertical intervals: lines, crossbars & errorbars
#'
#' @description
#' These geometries are based on [geom_crossbar()], [geom_errorbar()],
#' [geom_linerange()] and [geom_pointrange()].
#' These geometries are based on [ggplot2::geom_crossbar()], [ggplot2::geom_errorbar()],
#' [ggplot2::geom_linerange()] and [ggplot2::geom_pointrange()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_density_2d_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive contours of a 2d density estimate
#'
#' @description
#' The geometries are based on [geom_density_2d()] and [geom_density_2d_filled()].
#' The geometries are based on [ggplot2::geom_density_2d()] and [ggplot2::geom_density_2d_filled()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_density_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive smoothed density estimates
#'
#' @description
#' The geometry is based on [geom_density()].
#' The geometry is based on [ggplot2::geom_density()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_dotplot_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive dot plots
#'
#' @description
#' This geometry is based on [geom_dotplot()].
#' This geometry is based on [ggplot2::geom_dotplot()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_errorbarh_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Create interactive horizontal error bars
#'
#' @description
#' This geometry is based on [geom_errorbarh()].
#' This geometry is based on [ggplot2::geom_errorbarh()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_hex_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive hexagonal heatmaps
#'
#' @description
#' The geometry is based on [geom_hex()].
#' The geometry is based on [ggplot2::geom_hex()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
4 changes: 2 additions & 2 deletions R/geom_histogram_interactive.R
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#' @title Create interactive histograms and frequency polygons
#'
#' @description
#' The geometries are based on [geom_histogram()]
#' and [geom_freqpoly()].
#' The geometries are based on [ggplot2::geom_histogram()]
#' and [ggplot2::geom_freqpoly()].
#' See the documentation for those functions for more details.
#'
#' This interactive version is only providing a single tooltip per
Expand Down
2 changes: 1 addition & 1 deletion R/geom_jitter_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive jittered points
#'
#' @description
#' The geometry is based on [geom_jitter()].
#' The geometry is based on [ggplot2::geom_jitter()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_map_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive polygons from a reference map
#'
#' @description
#' The geometry is based on [geom_map()].
#' The geometry is based on [ggplot2::geom_map()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
4 changes: 2 additions & 2 deletions R/geom_path_interactive.R
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#' @title Create interactive observations connections
#'
#' @description
#' These geometries are based on [geom_path()],
#' [geom_line()] and [geom_step()].
#' These geometries are based on [ggplot2::geom_path()],
#' [ggplot2::geom_line()] and [ggplot2::geom_step()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_point_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive points
#'
#' @description
#' The geometry is based on [geom_point()].
#' The geometry is based on [ggplot2::geom_point()].
#' See the documentation for those functions for more details.
#'
#' @note
Expand Down
2 changes: 1 addition & 1 deletion R/geom_polygon_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive polygons
#'
#' @description
#' The geometry is based on [geom_polygon()].
#' The geometry is based on [ggplot2::geom_polygon()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_quantile_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive quantile regression
#'
#' @description
#' The geometry is based on [geom_quantile()].
#' The geometry is based on [ggplot2::geom_quantile()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_raster_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive raster rectangles
#'
#' @description
#' The geometry is based on [geom_raster()].
#' The geometry is based on [ggplot2::geom_raster()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_rect_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive rectangles
#'
#' @description
#' These geometries are based on [geom_rect()] and [geom_tile()].
#' These geometries are based on [ggplot2::geom_rect()] and [ggplot2::geom_tile()].
#' See the documentation for those functions for more details.
#'
#' @note
Expand Down
2 changes: 1 addition & 1 deletion R/geom_ribbon_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive ribbons and area plots
#'
#' @description
#' The geometries are based on [geom_ribbon()] and [geom_area()].
#' The geometries are based on [ggplot2::geom_ribbon()] and [ggplot2::geom_area()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_segment_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive line segments and curves
#'
#' @description
#' The geometries are based on [geom_segment()] and [geom_curve()].
#' The geometries are based on [ggplot2::geom_segment()] and [ggplot2::geom_curve()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
7 changes: 4 additions & 3 deletions R/geom_sf_interactive.R
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
#' @title Create interactive sf objects
#'
#' @description
#' These geometries are based on [geom_sf()], [geom_sf_label()] and [geom_sf_text()].
#' See the documentation for those functions for more details.
#' These geometries are based on [ggplot2::geom_sf()], [ggplot2::geom_sf_label()]
#' and [ggplot2::geom_sf_text()]. See the documentation for those functions for
#' more details.
#'
#' @param ... arguments passed to base function,
#' plus any of the [interactive_parameters].
Expand Down Expand Up @@ -33,7 +34,7 @@ GeomInteractiveSf <- ggproto(
lineend = "butt",
linejoin = "round",
linemitre = 10,
na.rm = TRUE,
na.rm = TRUE,
.ipar = IPAR_NAMES) {
# call original draw_panel for each data row/geometry
# this way multi geometries are handled too
Expand Down
2 changes: 1 addition & 1 deletion R/geom_smooth_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive smoothed conditional means
#'
#' @description
#' The geometry is based on [geom_smooth()].
#' The geometry is based on [ggplot2::geom_smooth()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_spoke_interactive.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#' parameterised by location, direction and distance
#'
#' @description
#' The geometry is based on [geom_spoke()].
#' The geometry is based on [ggplot2::geom_spoke()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_text_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive textual annotations
#'
#' @description
#' The geometries are based on [geom_text()] and [geom_label()].
#' The geometries are based on [ggplot2::geom_text()] and [ggplot2::geom_label()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/geom_violin_interactive.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' @title Create interactive violin plot
#'
#' @description
#' The geometry is based on [geom_violin()].
#' The geometry is based on [ggplot2::geom_violin()].
#' See the documentation for those functions for more details.
#'
#' @param ... arguments passed to base function,
Expand Down
2 changes: 1 addition & 1 deletion R/guide_bins_interactive.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' @title Create interactive bins guide
#' @description
#' The guide is based on [guide_bins()].
#' The guide is based on [ggplot2::guide_bins()].
#' See the documentation for that function for more details.
#'
#' @param ... arguments passed to base function.
Expand Down
2 changes: 1 addition & 1 deletion R/guide_colourbar_interactive.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' @title Create interactive continuous colour bar guide
#' @description
#' The guide is based on [guide_colourbar()].
#' The guide is based on [ggplot2::guide_colourbar()].
#' See the documentation for that function for more details.
#'
#' @param ... arguments passed to base function.
Expand Down
2 changes: 1 addition & 1 deletion R/guide_coloursteps_interactive.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' @title Create interactive colorsteps guide
#' @description
#' The guide is based on [guide_coloursteps()].
#' The guide is based on [ggplot2::guide_coloursteps()].
#' See the documentation for that function for more details.
#'
#' @param ... arguments passed to base function.
Expand Down
2 changes: 1 addition & 1 deletion R/guide_legend_interactive.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' @title Create interactive legend guide
#' @description
#' The guide is based on [guide_legend()].
#' The guide is based on [ggplot2::guide_legend()].
#' See the documentation for that function for more details.
#'
#' @param ... arguments passed to base function.
Expand Down
Loading

0 comments on commit f2b5422

Please sign in to comment.