MRIaggr-summary.MRIaggr: Summary Method for Class "MRIaggr"

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

Description

Summarize some information of an object of class "MRIaggr".

Usage

## S4 method for signature 'MRIaggr'
show(object)

## S4 method for signature 'MRIaggr'
summary(object, param = FALSE, clinic = FALSE, 
         descStats = FALSE, history = FALSE, verbose = optionsMRIaggr("verbose"))

Arguments

object	an object of class MRIaggr. REQUIRED.
param	should detailed information be printed for the contrast parameters ? logical.
clinic	should detailed information be printed for the clinical attribute ? logical.
descStats	should detailed information be printed for the ls_descStats attribute ? logical.
history	should thecalc and const methods that have been applied to the object be listed ? logical.
verbose	should a summary of all attributes should be displayed or only those which are non-empty ? logical.

Value

None.

Examples

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

# display all elements
summary(MRIaggr.Pat1_red)

# display non-empty elements
summary(MRIaggr.Pat1_red, verbose = FALSE)

# display a summary of the contrast parameters
summary(MRIaggr.Pat1_red, param = TRUE)

# display a summary of the clinical data
summary(MRIaggr.Pat1_red, clinic = TRUE)

# display a summary of the elements in descStats
summary(MRIaggr.Pat1_red, descStats = TRUE)

# display processing methods previously applied on the object
summary(MRIaggr.Pat1_red, history = TRUE)

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