Add a grid to VisiumHD surface plots — ggpLayerGridVisiumHD • SPATA2

Adds a grid overlay to VisiumHD spatial data at a specified resolution. This function is designed to work specifically with VisiumHD data within a SPATA2 object.

ggpLayerGridVisiumHD(
  object,
  res,
  line_alpha = 0.9,
  line_clr = "black",
  line_size = 0.5,
  img_name = activeImage(object)
)

Arguments

object: An object of class SPATA2 or, in case of S4 generics, objects of classes for which a method has been defined.
res: Distance measure. A value specifying the desired resolution for the grid. This resolution must be lower than or equal to the current resolution and divisible by the current resolution.
line_alpha: Numeric. Affects alpha of main lines of the plot.
line_size: Numeric. Affects size of the main lines of the plot.
img_name: Character value. The name of the image of interest. If NULL, the active image is chosen by default. Either way, must be one of getImageNames().

Value

ggpLayer*()-functions return lists of ggproto objects that can be added to ggplots via the + operator. In most of the cases they are supposed to be added to plots created with the plotSurface*() family.