coat: Coat Function
In mand: Multivariate Analysis for Neuroimaging Data

View source: R/src.r

coat	R Documentation

Coat Function

Description

This is a function for plotting an image. The analysis result can be overcoated on the template.

Usage

coat(
  x,
  y = NULL,
  pseq = NULL,
  xyz = NULL,
  col.x = gray(0:64/64),
  col.y = NULL,
  breaks.y = NULL,
  zlim.x = NULL,
  zlim.y = NULL,
  rownum = 5,
  colnum = NULL,
  plane = c("axial", "coronal", "sagittal", "all")[1],
  xlab = "",
  ylab = "",
  axes = FALSE,
  oma = rep(0, 4),
  mar = rep(0, 4),
  bg = "black",
  paron = TRUE,
  cross.hair = FALSE,
  chxy = NULL,
  color.bar = TRUE,
  regionplot = FALSE,
  atlasdataset = NULL,
  regionname = c("atlas", "stat")[1],
  regionlegend = FALSE,
  atlasname = "",
  ROIids = 1:9,
  ...
)

Arguments

`x`	image1. Base image.
`y`	image2 to be overcoated.
`pseq`	a vector plot sequence.
`xyz`	a vector position to be plotted.
`col.x`	a color vector for image1.
`col.y`	a color vector for image2.
`breaks.y`	a vector breaks value for y.
`zlim.x`	a vector plot limitation values for z of x.
`zlim.y`	a vector plot limitation values for z of y.
`rownum`	a numeric, the number of row for the plot.
`colnum`	a numeric, the number of colnum for the plot.
`plane`	a vector plot sequence.
`xlab`	a character for a label in the x axis.
`ylab`	a character for a label in the y axis.
`axes`	a logical. TRUE presents the axes.
`oma`	a vector for outer margin area.
`mar`	a vector for margin.
`bg`	a character for color of background.
`paron`	a logical. TRUE means par is used.
`cross.hair`	a logical.
`chxy`	a vector cross hair position to be plotted.
`color.bar`	a logical.
`regionplot`	a logical.
`atlasdataset`	a matrix or data.frame. colnames shold include "ROIid" and "ROIname".
`regionname`	a character.
`regionlegend`	a logical.
`atlasname`	a character.
`ROIids`	a vector
`...`	further arguments passed to or from other methods.