rasterly (version 0.2.0)

rplot: Rasterly plot

Description

rplot is created to generate rasterly plot quickly but with base plot design. It is convenient but lacks flexibility and rasterly is highly recommended for a more versatile method.

Usage

rplot(x, y = NULL, ...)
# S3 method for default
rplot(
  x,
  y = NULL,
  ...,
  plot_width = 600,
  plot_height = 600,
  x_range = NULL,
  y_range = NULL,
  background = "white",
  reduction_func = NULL,
  layout = NULL,
  glyph = NULL
)

Arguments

x, y

Coordinates x, y for the plot.

...

Other rasterly arguments to pass through.

plot_width

Integer. The width of the image to plot; must be a positive integer. A higher value indicates a higher resolution.

plot_height

Integer. The height of the image to plot; must be a positive integer. A higher value indicates a higher resolution.

x_range

Vector of type numeric. The range of x; it can be used to clip the image. For larger datasets, providing x_range may result in improved performance.

y_range

Vector of type numeric. The range of y; it can be used to clip the image. For larger datasets, providing y_range may result in improved performance.

background

Character. The background color of the image to plot.

reduction_func

Function. A reduction function is used to aggregate data points into their pixel representations. Currently supported reduction operators are sum, any, mean, m2, first, last, min and max. Default is sum. See details.

layout

Character. The method used to generate layouts for multiple images. The default is weighted. Useful for categorical data (i.e. "color" is provided via aes()). weighted specifies that the final raster should be a weighted combination of each (categorical) aggregation matrix. Conversely, cover indicates that the afterwards objects will be drawn on top of the previous ones.

glyph

Character. Currently, only "circle" and "square" are supported; as the size of the pixels increases, how should they spread out -- should the pattern be circular or square? Other glyphs may be added in the future.

Details

rasterly arguments are passed through via .... But some of them are noticeable.

• size: Size can be either a specified size (1, 2, 3, etc) or a mapping variable. Since rasterly does not provide point to point display, if the length of input size is the same with the length of x (or y). It will be treated as a mapping variable.

• color: Color can be either a color map vector or a mapping variable. If the length of color is equal to the length of x (or y). It will be treated as a mapping variable.

• on: On is always treated as a mapping variable.

See Also

rasterly rasterly_points

Examples

# NOT RUN {
if(requireNamespace("ggplot2")) {
  library(ggplot2)
  # `color` represents a variable here
  with(diamonds, 
       rplot(x = carat, y = price, color = color)
  )
  # `color` represents an actual color vector
  with(diamonds, 
       rplot(x = carat, y = price, color = fire_map)
  )
}
# }