plot.stim: Plotting 'stim' objects

View source: R/plot.stim.R

plot.stimR Documentation

Plotting 'stim' objects

Description

plot method for class stim.

Usage

## S3 method for class 'stim'
plot(x, fix.range = FALSE, sleep = 0.2, override.par = TRUE, ...)

Arguments

x

An object of class stim.

fix.range

Logical value indicating whether use the same color scale limits for each plot in the sequence. Ignored if the user supplies a pre-defined colourmap to the col argument, which is matched to ... and passed to plot.im.

sleep

Single positive numeric value giving the amount of time (in seconds) to Sys.sleep before drawing the next image in the animation.

override.par

Logical value indicating whether to override the existing graphics device parameters prior to plotting, resetting mfrow and mar. See ‘Details’ for when you might want to disable this.

...

Additional graphical parameters to be passed to plot.im (see ‘Details’).

Details

Actual visualisation is deferred to plot.im, for which there are a variety of customisations available the user can access via ....

The stim object is plotted as an animation, one pixel image after another, separated by sleep seconds. If instead you intend the individual images to be plotted in an array of images, you should first set up your plot device layout, and ensure override.par = FALSE so that the function does not reset these device parameters itself. In such an instance, one might also want to set sleep = 0.

Value

Plots to the active graphics device.

Author(s)

T.M. Davies

Examples

# See help(stgmix) and help(stkey) for examples

spagmix documentation built on March 28, 2022, 5:07 p.m.