stat_scalpmap: Create an interpolated scalp surface

In craddm/eegUtils: Utilities for Electroencephalographic (EEG) Analysis

Create an interpolated scalp surface

Description

stat_scalpmap creates an interpolated surface for an irregular set of x-y coordinates, as is typically required for a topographical EEG plot. Since the surface should be approximately round, the function attempts to blank out portions of the surface that lay outside the area within the electrodes.

geom_head() adds a headshape to a plot.

geom_mask() adds a masking ring to smooth the edges of a scalp map generated by stat_scalpmap(), to give it a circular appearance.

geom_ears simply draws a pair of ears attached to the head shape.

geom_channels adds either points or text labels at channel locations. This is a convenience function to prevent overplotting when the input data contains many rows of data.

Usage

stat_scalpmap(
  mapping = NULL,
  data = NULL,
  position = "identity",
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE,
  grid_res = 200,
  interpolate = FALSE,
  interp_limit = c("skirt", "head"),
  method = "biharmonic",
  r = NULL,
  ...
)

geom_head(
  mapping = NULL,
  data = NULL,
  show.legend = NA,
  na.rm = TRUE,
  inherit.aes = TRUE,
  interp_limit = "skirt",
  r = 95,
  ...
)

geom_mask(
  mapping = NULL,
  data = NULL,
  show.legend = NA,
  na.rm = FALSE,
  colour = "white",
  size = rel(5),
  linewidth = rel(5),
  r = 95,
  interp_limit = "skirt",
  ...
)

geom_ears(
  mapping = NULL,
  data = NULL,
  show.legend = NA,
  na.rm = FALSE,
  r = 95,
  ...
)

geom_channels(
  mapping = NULL,
  data = NULL,
  geom = "point",
  show.legend = NA,
  inherit.aes = TRUE,
  na.rm = TRUE,
  ...
)

Arguments

mapping	Set of aesthetic mappings created by 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)).
position	A position adjustment to use on the data for this layer. This can be used in various ways, including to prevent overplotting and improving the display. The position argument accepts the following: The result of calling a position function, such as position_jitter(). This method allows for passing extra arguments to the position. A string naming the position adjustment. To give the position as a string, strip the function name of the position_ prefix. For example, to use position_jitter(), give the position as "jitter". For more information and other ways to specify the position, see the layer position documentation.
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().
grid_res	Resolution of the interpolation grid. (Defaults to 200 points).
interpolate	If TRUE interpolate linearly, if FALSE (the default) don't interpolate.
interp_limit	Topoplot with a "skirt" or inside the "head".
method	"biharmonic" or "gam"
r	Radius of head
...	Other arguments passed on to layer()'s params argument. These arguments broadly fall into one of 4 categories below. Notably, further arguments to the position argument, or aesthetics that are required can not be passed through .... Unknown arguments that are not part of the 4 categories below are ignored. Static aesthetics that are not mapped to a scale, but are at a fixed value and apply to the layer as a whole. For example, colour = "red" or linewidth = 3. The geom's documentation has an Aesthetics section that lists the available options. The 'required' aesthetics cannot be passed on to the params. Please note that while passing unmapped aesthetics as vectors is technically possible, the order and required length is not guaranteed to be parallel to the input data. When constructing a layer using a ⁠stat_*()⁠ function, the ... argument can be used to pass on parameters to the geom part of the layer. An example of this is stat_density(geom = "area", outline.type = "both"). The geom's documentation lists which parameters it can accept. Inversely, when constructing a layer using a ⁠geom_*()⁠ function, the ... argument can be used to pass on parameters to the stat part of the layer. An example of this is geom_area(stat = "density", adjust = 0.5). The stat's documentation lists which parameters it can accept. The key_glyph argument of layer() may also be passed on through .... This can be one of the functions described as key glyphs, to change the display of the layer in the legend.
colour	For geom_mask, colour of the masking ring.
size	For geom_mask, width of the masking ring. Deprecated.
linewidth	For geom_mask, width of the masking ring.
geom	"point" for points or "text" for labels. Default is "point".

Author(s)

Matt Craddock [e-mail]

See Also

Other topoplot functions: geom_topo(), stat_scalpcontours()

Other topoplot functions: geom_topo(), stat_scalpcontours()

Other topoplot functions: geom_topo(), stat_scalpcontours()

craddm/eegUtils documentation built on March 1, 2025, 3:23 p.m.