MRIaggr-boxplotMask: Boxplot spatial group characteristics

In bozenne/MRIaggr: Management, Display, and Processing of Medical Imaging Data

Description

Display a boxplot of the contrast parameter values inside and outside a spatial group.

Usage

## S4 method for signature 'MRIaggr'
boxplotMask(object, param, mask, num = NULL, rescale = TRUE,  
         ylim = NULL, col = c("white", "purple"), main = NULL, mgp = c(2, 0.5, 0),
		 x.legend = "topright", y.legend = NULL, cex.legend = 0.8, 
         filename = paste(object@identifier, "boxplotMask", sep = "_"), ...)

Arguments

object	an object of class MRIaggr. REQUIRED.
param	the contrast parameter(s) associated with the lesion mask(s). character vector. REQUIRED.
mask	the binary contrast parameter(s) defining the spatial group(s). character vector. REQUIRED.
num	the slices to consider. numeric vector or NULL.
rescale	should the contrast parameters be scaled ? logical.
ylim	the y limits of the plot. numeric vector of size 2 or NULL leading to automatic setting of the y limits.
col	the colors of the boxplots for observations inside and outside the mask(s). character vector of size 2.
main	an overall title for the plot. character.
mgp	the margin line for the axis title, axis labels and axis line. positive numeric vector of size 3.
x.legend	the x coordinates of the legend. numeric or character.
y.legend	the y coordinates of the legend. numeric or character.
cex.legend	the expansion factor of the legend. positive numeric.
filename	the name of the file used to export the plot. character.
...	additional arguments to be passed to optionsMRIaggr for specifying the graphical parameters.

Details

ARGUMENTS:
Information about the num argument can be found in the details section of initNum.

Information about the mgp argument can be found in par.

Information about the x.legend, y.legend, cex.legend arguments can be found in legend (cex.legend is the cex argument of legend).

Arguments ... must correspond to some of the following arguments : height, hemisphere, norm_mu, norm_sigma, numeric2logical, path, res, unit, width, window.

Value

None.

Examples

## load a MRIaggr object
data("MRIaggr.Pat1_red", package = "MRIaggr")

## display
boxplotMask(MRIaggr.Pat1_red, param = c("DWI_t0","TTP_t0","MTT_t0"),mask = "MASK_T2_FLAIR_t2",
     numeric2logical = TRUE)

bozenne/MRIaggr documentation built on May 13, 2019, 1:39 a.m.