stackplot.mrs_data: Stackplot plotting method for objects of class mrs_data.

In neuroconductor-releases/spant: MR Spectroscopy Analysis Tools

Description

Stackplot plotting method for objects of class mrs_data.

Usage

## S3 method for class 'mrs_data'
stackplot(
  x,
  xlim = NULL,
  mode = "re",
  x_units = NULL,
  fd = TRUE,
  col = NULL,
  x_offset = 0,
  y_offset = 0,
  dim = "dyn",
  x_pos = NULL,
  y_pos = NULL,
  z_pos = NULL,
  dyn = 1,
  coil = 1,
  bty = NULL,
  labels = NULL,
  lab_cex = 1,
  right_marg = NULL,
  bl_lty = NULL,
  restore_def_par = TRUE,
  ...
)

Arguments

x	object of class mrs_data.
xlim	the range of values to display on the x-axis, eg xlim = c(4,1).
mode	representation of the complex numbers to be plotted, can be one of: "re", "im", "mod" or "arg".
x_units	the units to use for the x-axis, can be one of: "ppm", "hz", "points" or "seconds".
fd	display data in the frequency-domain (default), or time-domain (logical).
col	set the colour of the line, eg col = rgb(1,0,0,0.5).
x_offset	separate plots in the x-axis direction by this value. Default value is 0.
y_offset	separate plots in the y-axis direction by this value.
dim	the dimension to stack in the y-axis direction, can be one of: "dyn", "x", "y", "z" or "coil".
x_pos	the x index to plot.
y_pos	the y index to plot.
z_pos	the z index to plot.
dyn	the dynamic index to plot.
coil	the coil element number to plot.
bty	option to draw a box around the plot. See ?par.
labels	add labels to each data item.
lab_cex	label size.
right_marg	change the size of the right plot margin.
bl_lty	linetype for the y = 0 baseline trace. A default value NULL results in no baseline being plotted.
restore_def_par	restore default plotting par values after the plot has been made.
...	other arguments to pass to the matplot method.

neuroconductor-releases/spant documentation built on Jan. 1, 2021, 11:42 a.m.