mt_heatmap {mousetrap}

Plot trajectory heatmap.

Description

mt_heatmap plots high resolution raw trajectory maps. Note that this function has beta status.

Usage

mt_heatmap(
  x,
  use = "trajectories",
  dimensions = c("xpos", "ypos"),
  filename = NULL,
  ...,
  upscale = 1,
  plot_dims = FALSE,
  verbose = TRUE
)

Arguments

x

usually an object of class mousetrap. Alternatively, a trajectory array or an object of class mt_heatmap_raw.

use

a character string specifying which trajectory data should be used.

dimensions

a character vector specifying the trajectory variables used to create the heatmap. The first two entries are used as x and y-coordinates, the third, if provided, will be added as color information.

filename

a character string giving the name of the file. If NULL (the default), the R standard device is used for plotting. Otherwise, the plotting device is inferred from the file extension. Only supports devices tiff, png, pdf.

...

arguments passed to mt_heatmap_raw.

upscale

a numeric value by which the output resolution of the image is increased or decreased. Only applies if device is one of tiff, png, or pdf.

plot_dims

adds the coordinates of the four image corners to the plot. Helps setting bounds.

verbose

logical indicating whether function should report its progress.

Details

mt_heatmap wraps mt_heatmap_raw and provides direct plotting output in tiff, png, pdf, or R's default window output. For further details on how the trajectory heatmaps are constructed, see mt_heatmap_raw.

Author(s)

Dirk U. Wulff

References

Wulff, D. U., Haslbeck, J. M. B., Kieslich, P. J., Henninger, F., & Schulte-Mecklenbeck, M. (2019). Mouse-tracking: Detecting types in movement trajectories. In M. Schulte-Mecklenbeck, A. Kühberger, & J. G. Johnson (Eds.), A Handbook of Process Tracing Methods (pp. 131-145). New York, NY: Routledge.

Kieslich, P. J., Henninger, F., Wulff, D. U., Haslbeck, J. M. B., & Schulte-Mecklenbeck, M. (2019). Mouse-tracking: A practical guide to implementation and analysis. In M. Schulte-Mecklenbeck, A. Kühberger, & J. G. Johnson (Eds.), A Handbook of Process Tracing Methods (pp. 111-130). New York, NY: Routledge.

See Also

mt_heatmap_ggplot for plotting a trajectory heatmap using ggplot2.

mt_diffmap for plotting trajectory difference-heatmaps.

Examples

## Not run: 
mt_heatmap(KH2017, xres=500, n_shades=5, mean_image=0.2)

## End(Not run)