geom_rect_img: Display Images from Bounding Boxes

In ggimg: Graphics Layers for Plotting Image Data with 'ggplot2'

Display Images from Bounding Boxes

Description

Display Images from Bounding Boxes

Usage

geom_rect_img(
  mapping = NULL,
  data = NULL,
  stat = "identity",
  position = "identity",
  show.legend = NA,
  inherit.aes = TRUE,
  ...,
  interpolate = TRUE
)

GeomRectImage

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. 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. A 'function' can be created from a 'formula' (e.g. '~ head(.x, 10)').
stat	The statistical transformation to use on the data for this layer, as a string.
position	Position adjustment, either as a string, or the result of a call to a position adjustment function.
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.
interpolate	A logical value indicating whether to linearly interpolate the image (the alternative is to use nearest-neighbour interpolation, which gives a more blocky result).

Format

An object of class GeomRectImage (inherits from Geom, ggproto, gg) of length 6.

Author(s)

Taylor B. Arnold, [e-mail]

Examples

library(ggplot2)
posters$path <- file.path(
  system.file("extdata", package="ggimg"), posters$img
)
p_paths <- ggplot(posters) +
 geom_rect_img(aes(
    xmin = year - 0.5,
    xmax = year + 0.5,
    ymin = stars - 0.5,
    ymax = stars + 0.5,
    img = path
  ))

ggimg documentation built on Aug. 17, 2022, 5:06 p.m.