polarHeatMap: Create a plot with a polar heatmap.
In thartbm/SMCL: Utilities for common tasks in the SensoriMotor Control Lab.

polarHeatMap

R Documentation

Create a plot with a polar heatmap.

Description

Usage

polarHeatMap(
  x,
  y,
  z,
  mincol = c(0.94, 0.98, 0.99),
  maxcol = c(0.06, 0.82, 0.88),
  xlim = NA,
  ylim = NA,
  xunit = "degrees",
  border = NA,
  bordercol = "white",
  resolution = 1,
  alpha = 1,
  overlay = FALSE,
  origin = c(0, 0),
  scale = 1,
  main = ""
)

Arguments

`x`	Vector of M+1 angular bin edges.
`y`	Vector of N+1 distance bin edges.
`z`	Matrix (MxN) with two-dimensional histogram (frequency data), for example from SMCL::hist2d.
`mincol`	Vector of length 3 with RGB values [0-1] for the minimum value in z.
`maxcol`	Vector of length 3 with RGB values [0-1] for the maximum value in z. Other values in z are scaled, and each of the R, G and B values is linearly interpolated. No support for colormaps (yet).
`xlim`	Vector with values limiting the x axis of the resulting plot.
`ylim`	Vector with values limiting the y axis of the resulting plot. By default, the is set to c(-1,1) for both x and y, as this will include the full polar figure. Only change these values when the data do not cover a circular data set.
`xunit`	The angular unit (of the x-coordinates). Can be 'degrees' or 'radians'. Will be converted to 'radians' if set in degrees.
`border`	Draw borders around the parts of the heatmap. By default this is set to NA, which means no border is drawn. If set to a numeric value, it is used as the linewidth of the borders.
`bordercol`	The color of the borders drawn around parts of the heatmap. Default is 'white', can be any color accepted by base R graphics.
`resolution`	The cicrular parts of the heatmap are approximated as a polygon, with at maximum this number of degrees between vectors. Default: 1.
`alpha`	The alpha value of the heatmap. Does not apply to the border.
`overlay`	Whether to put the polar heatmap into the active plot, or create a new one. Default is FALSE: create new plot.
`origin`	The coordinates of the centre of the polar heatmap. Useful when overlay=TRUE. Defaults to (0,0).
`scale`	The size of the polar heatmap. Useful when overlay=TRUE. Defaults to 1.
`main`	Main title when creating a new plot window.