summary.partition: Provides a summary of a partition
Description
Provides a summary of an object of class partition: usually the
first and last few partitions (columns)
Usage
summary.partition(object, ...)
Arguments
object
Partition
...
Further arguments; see details section below
Value
A summary object is a list, comprising three elements:
shortenedBoolean, with TRUE meaning that the middle
section of the matrix is ommitted, and FALSE meaning that the
entire matrix is returned because n is too big
nNumber of columns to return at the start and the end of the matrix
outMatrix returned: just the first and last n columns
(if shortened is TRUE), or the whole matrix if not
Details
The ellipsis arguments are used to pass how many columns at the start
and the end of the matrix are selected; this defaults to 10.
The function is designed to behave as expected: if there is an
argument named n, then this is used. If there is no
such argument, the first one is used.