loon.ggplot (version 1.0.1)

geom_imageGlyph: Add image glyph on scatter plot

Description

The glyph geom is used to create scatterplots with a variety glyphs such as polygon glyph, serialaxes glyph, image glyph, point range glyph and text glyph.

Usage

geom_imageGlyph(
  mapping = NULL,
  data = NULL,
  stat = "identity",
  position = "identity",
  ...,
  images,
  width = 4,
  height = 3,
  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. 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.

...

Other arguments passed on to ggplot2::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.

images

a list of images (a raster object, bitmap image). If not provided, geom_point() will be called.

width

width of image

height

height of image

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().

Value

a geom layer

See Also

geom_polygonGlyph, geom_pointrangeGlyph, geom_serialAxesGlyph, geom_textGlyph

Examples

# NOT RUN {
# image glyph
# }
# NOT RUN {
if(requireNamespace("png")) {
  img_paths <- list.files(file.path(find.package(package = 'loon'), "images"), full.names = TRUE)
  images <- lapply(img_paths, function(path) png::readPNG(path))
  p <- ggplot(data = data.frame(x = 1:6, y = 1:6),
              mapping = aes(x = x, y = y)) +
         geom_imageGlyph(images = images, alpha = 0.4, width = 2, height = 1.5)
  p
}
# }
# NOT RUN {
# }