ena.plotter: Wrapper to generate plots of units, groups, and networks

View source: R/ena.plotter.R

ena.plotterR Documentation

Wrapper to generate plots of units, groups, and networks

Description

Plots individual units, all units, groups of units, networks, and network subtractions

Usage

ena.plotter(
  set,
  groupVar = NULL,
  groups = NULL,
  points = FALSE,
  mean = FALSE,
  network = TRUE,
  networkMultiplier = 1,
  subtractionMultiplier = 1,
  unit = NULL,
  print.plots = F,
  ...
)

Arguments

set

an ena.set object

groupVar

vector, character, of column name containing group identifiers.

groups

vector, character, of values of groupVar column you wish to plot. Maxium of two groups allowed.

points

logical, TRUE will plot points (default: FALSE)

mean

logical, TRUE will plot the mean position of the groups defined in the groups argument (default: FALSE)

network

logical, TRUE will plot networks (default: TRUE)

networkMultiplier

numeric, scaling factor for non-subtracted networks (default: 1)

subtractionMultiplier

numeric, scaling factor for subtracted networks (default: 1)

unit

vector, character, name of a single unit to plot

print.plots

logical, TRUE will show plots in the Viewer (default: FALSE)

...

Additional parameters passed to set creation and plotting functions

Details

This function includes options to plots individual units, all units, groups of units, networks, and network subtractions, given an ena.set objects. Plots are stored on the supplied ena.set object.

Value

ena.set object


rENA documentation built on March 26, 2022, 1:10 a.m.