position_beeswarm: Arrange points using the `\link[beeswarm]` package.

Description

Arrange points using the \link[beeswarm] package.

Usage

position_beeswarm(
  method = "swarm",
  cex = 1,
  side = 0L,
  priority = "ascending",
  fast = TRUE,
  orientation = NULL,
  groupOnX = NULL,
  dodge.width = 0,
  corral = "none",
  corral.width = 0.2,
  preserve.data.axis = FALSE
)

Arguments

method: Method for arranging points. Options are "swarm" (default), "compactswarm", "square", "hex", and "center". See Details below.
cex: Scaling for adjusting point spacing (see beeswarm::swarmx()). Values between 1 (default) and 3 tend to work best.
side: Direction to perform jittering: 0: both directions; 1: to the right or upwards; -1: to the left or downwards.
priority: Method used to perform point layout. Options are "ascending" (default), "descending", "density", "random", or "none". See Details below.
fast: If TRUE (default), use compiled version of swarm algorithm. This option is ignored for all methods except "swarm" and "compactswarm".
orientation: The orientation (i.e., which axis to group on) is inferred from the data. This can be overridden by setting orientation to either "x" or "y".
groupOnX: See orientation.
dodge.width: Amount by which points from different aesthetic groups will be dodged. This requires that one of the aesthetics is a factor.
corral: Method used to adjust points that would be placed too wide horizontally. Options are "none" (default), "gutter", "wrap", "random", and "omit". See Details below.
corral.width: Width of the corral, if not "none". Default is 0.9.
preserve.data.axis: If TRUE, prevent method from modifying the data axis (default FALSE). See Details for more info.

Details

method: specifies the algorithm used to avoid overlapping points. The default "swarm" method places points in increasing order. If a point would overlap with an existing point, it is shifted sideways (along the group axis) by a minimal amount sufficient to avoid overlap.

While the "swarm" method places points in a predetermined order, the "compactswarm" method uses a greedy strategy to determine which point will be placed next. This often leads to a more tightly-packed layout. The strategy is very simple: on each iteration, a point that can be placed as close as possible to the non-data axis is chosen and placed. If there are two or more equally good points, priority is used to break ties.

The other 3 methods first discretise the values along the data axis, in order to create more efficient packing. The "square" method places points on a square grid, whereas "hex" uses a hexagonal grid. "centre"/"center" uses a square grid to produce a symmetric swarm. The number of break points for discretisation is determined by a combination of the available plotting area and the cex argument.

priority: controls the order in which points are placed, which generally has a noticeable effect on the plot appearance. "ascending" gives the 'traditional' beeswarm plot. "descending" is the opposite. "density" prioritizes points with higher local density. "random" places points in a random order. "none" places points in the order provided.

corral: By default, swarms from different groups are not prevented from overlapping, i.e. "corral = "none". Thus, datasets that are very large or unevenly distributed may produce ugly overlapping beeswarms. To control runaway points one can use the following methods. "gutter" collects runaway points along the boundary between groups. "wrap" implement periodic boundaries. "random" places runaway points randomly in the region. "omit" omits runaway points.

#' preserve.data.axis: In some cases, the underlying method may attempt to change the position of points along the ungrouped, or data, axis, in order to keep them from overlapping. To prevent this, set this option to TRUE.

Description

Usage

Arguments

Details

See Also