R: Draw regular polygons by specifying number of sides

geom_regon {ggforce} | R Documentation

## Draw regular polygons by specifying number of sides

### Description

This geom makes it easy to construct regular polygons (polygons where all sides and angles are equal) by specifying the number of sides, position, and size. The polygons are always rotated so that they "rest" on a flat side, but this can be changed with the angle aesthetic. The size is based on the radius of their circumcircle and is thus not proportional to their area.

### Usage

    stat_regon(mapping = NULL, data = NULL, geom = "shape",
      position = "identity", na.rm = FALSE, show.legend = NA,
      inherit.aes = TRUE, ...)

    geom_regon(mapping = NULL, data = NULL, stat = "regon",
      position = "identity", na.rm = FALSE, show.legend = NA,
      inherit.aes = TRUE, ...)

### Arguments

`mapping` | Set of aesthetic mappings created by `aes()` or `aes_()`. If specified and `inherit.aes = TRUE` (the default), it is combined with the default mapping at the top level of the plot. You must supply `mapping` if there is no plot mapping.
`data` | The data to be displayed in this layer. There are three options: If `NULL`, the default, the data is inherited from the plot data as specified in the call to `ggplot()`. A `data.frame`, or other object, will override the plot data. All objects will be fortified to produce a data frame. See `fortify()` for which variables will be created. A `function` will be called with a single argument, the plot data. The return value must be a `data.frame`, and will be used as the layer data.
`geom` | The geometric object to use display the data
`position` | Position adjustment, either as a string, or the result of a call to a position adjustment function.
`na.rm` | If `FALSE`, the default, missing values are removed with a warning. If `TRUE`, missing values are silently removed.
`show.legend` | logical. Should this layer be included in the legends? `NA`, the default, includes if any aesthetics are mapped. `FALSE` never includes, and `TRUE` always includes. It can also be a named logical vector to finely select the aesthetics to display.
`inherit.aes` | If `FALSE`, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. `borders()`.
`...` | Other arguments passed on to `layer()`. These are often aesthetics, used to set an aesthetic to a fixed value, like `colour = "red"` or `size = 3`. They may also be parameters to the paired geom/stat.
`stat` | The statistical transformation to use on the data for this layer, as a string.

### Aesthetics

geom_regon understand the following aesthetics (required aesthetics are in bold):

- x0

- y0

- sides

- r

- angle

- color

- fill

- size

- linetype

- alpha

- lineend

### Computed variables

x, y

  The coordinates for the corners of the polygon

### Examples

    ggplot() +
      geom_regon(aes(x0 = runif(8), y0 = runif(8), sides = sample(3:10, 8),
                     angle = 0, r = runif(8) / 10)) +
      coord_fixed()

    # The polygons are drawn with geom_shape, so can be manipulated as such
    ggplot() +
      geom_regon(aes(x0 = runif(8), y0 = runif(8), sides = sample(3:10, 8),
                     angle = 0, r = runif(8) / 10),
                 expand = unit(1, 'cm'), radius = unit(1, 'cm')) +
      coord_fixed()

[Package ggforce version 0.2.2 Index]