Skip to contents

2D and 3D Scatter Plot Display for Tours

Source: R/show_scatter.R
show_scatter.Rd

Display method for a high performance 2D or 3D scatter plot. Performance is achieved through the use of Three.js / WebGL, and the 2D or 3D variant is selected automatically based on the tour generator provided.

Usage

show_scatter(
  x,
  ...,
  palette = viridis,
  center = TRUE,
  axes = TRUE,
  edges = NULL,
  paused = TRUE,
  scale_factor = NULL
)

Arguments

x

a detour object

...

used to support aesthetic parameters for the plot, including

  • size: point size, defaults to 1

  • alpha: point opacity, defaults to 1

  • background_colour: defaults to "white"

palette

Colour palette to use with the colour aesthetic. Can be:

  • A character vector of R colours. This should match the number of levels of the colour aesthetic, or the number of bins to use for continuous colours.

  • A function which takes the number of colours to use as input and returns a character vector of colour names and / or hex values as output.

center

If TRUE, center the projected data to (0, 0, 0).

axes

Can be one of:

  • TRUE draw axes and use column names for axis labels

  • FALSE do not draw axes or labels

  • NULL draw axes with no labels

  • An unnamed vector of labels with the same length as cols

  • A named vector in the form c("h" = "head"), where head is renamed to h

edges

A two column numeric matrix giving indices of ends of lines.

paused

whether the widget should be initialised in the 'paused' state

scale_factor

used as a multiplier for the point coordinates so they are displayed on a sensible range. Defaults to the reciprocal of maximum distance from a point to the origin.

Value

An object of class htmlwidget

Details

This display method produces an interactive scatterplot animation which supports both 2D and 3D tours. Linked selection and filtering is also supported using crosstalk. The set of interactive controls available are:

  • A timeline with a play / pause button and indicators at the position of each basis used. The basis indicators can be hovered with the mouse to show the index of the basis, or clicked to jump to that basis. The timeline also allows for clicking and dragging of the scrubber to move to any individual frame of the animation.

  • Orbit controls. For the 2D variant, this allows the projection to be rotated by clicking and dragging from left to right. For the 3D variant, full orbit controls are available by clicking and dragging. For both orbit and pan controls, the scroll wheel can be used to zoom.

  • Pan controls, which work similarly to orbit controls but move the camera laterally / vertically rather than rotating

  • Resetting of the orbit and pan controls

  • Selection and highlighting. Multiple selection is possible by using the shift key

  • Colouring / brushing of highlighted points

Examples

detour(tourr::flea, tour_aes(projection = -species, colour = species)) |>
  tour_path(grand_tour(3), fps = 60) |>
  show_scatter(alpha = 0.7, axes = FALSE)