mplot3_laterality: Laterality scatter plot

View source: R/mplot3_laterality.R

mplot3_lateralityR Documentation

Laterality scatter plot

Description

Laterality scatter plot

Usage

mplot3_laterality(
  x,
  regionnames,
  main = NULL,
  ylab = "Left to Right",
  summary.fn = "median",
  summary.lty = 1,
  summary.lwd = 2.5,
  summary.col = NULL,
  arrowhead.length = 0.075,
  deltas = TRUE,
  line.col = theme$fg,
  line.alpha = 0.25,
  lty = 1,
  lwd = 0.3,
  ylim = NULL,
  theme = rtTheme,
  labelify = TRUE,
  autolabel = letters,
  mar = NULL,
  oma = rep(0, 4),
  pty = "m",
  palette = rtPalette,
  par.reset = TRUE,
  pdf.width = 6,
  pdf.height = 6,
  filename = NULL,
  ...
)

Arguments

x

data.frame or data.table which includes columns with ROI names ending in "_L" or "_R"

regionnames

Character, vector: Regions to plot. For example, if regionnames contains "Ant_Insula", x must contain columns Ant_Insula_L and Ant_Insula_R

main

Character: Plot title

ylab

Character: y-axis label

summary.fn

Character: Name of function to summarize left and right values. Default = "median"

summary.lty

Integer: line type for summary arrows

summary.lwd

Float: line width for summary arrows

summary.col

Color for summary arrows

arrowhead.length

Float: arrowhead length in inches. Default = .075

deltas

Logical, If TRUE, show summary statistics. Default = TRUE

line.col

Color for individual cases' lines

line.alpha

Float: transparency for individual lines

lty

Integer: Line type for individual lines. Default = 1

lwd

Float: Line width for individual lines. Default = .3

ylim

Float, vector, length 2: y-axis limits

theme

Character: Run themes() for available themes

labelify

Logical: If TRUE, labelify regionnames

autolabel

Character vector to be used to generate autolabels when using rtlayout with autolabel = TRUE.

mar

Float, vector, length 4: Margins; see par("mar")

oma

Float, vector, length 4: Outer margins; see par("oma")

pty

Character: "s" gives a square plot; "m" gives a plot that fills graphics device size. Default = "m" (See par("pty"))

palette

Vector of colors, or Character defining a builtin palette - get options with rtpalette()

par.reset

Logical: If TRUE, reset par setting before exiting.

pdf.width

Float: Width in inches for pdf output (if filename is set).

pdf.height

Float: Height in inches for pdf output.

filename

Character: Path to file to save plot. Default = NULL

...

Additional arguments to be passed to theme function

Author(s)

E.D. Gennatas


egenn/rtemis documentation built on Nov. 22, 2024, 4:12 a.m.