summary.wccsom: Summarizing wccsom objects

Description Usage Arguments Details Author(s) See Also Examples

View source: R/summary.R

Description

Summary for objects of class '"wccsom"'

Usage

1
2
3
4
5
## S3 method for class 'wccsom'
summary(object, type = c("unit", "object", "smoothness", "quality"),
               nr, labels, data = object$data,
               classif = object$unit.classif,
               wccs = object$wccs, properties = NULL, ...)

Arguments

object

Trained Kohonen map.

type

One of "unit", "object", "smoothness" or "quality".

nr

Number of the unit or object that is to be summarised (only needed for type "unit" and "object").

labels

Labels for all objects (not needed for type equaling "smoothness" and "quality"). Defaults to integer numbers.

data

Data matrix (not needed for type equaling "smoothness"). Default is to take the training objects (if available).

classif

Mapping of all objects (not needed for type equaling "smoothness"). Default is to take the mapping of the training objects (if available). Alternatively, a mapping object (output of wccassign may be given for this argument.

wccs

WCC values of all mapped objects (not needed for type equaling "smoothness"). Default is to take the training objects (if available).

properties

Other properties of the crystals that should be shown in the summary, as e.g. reduced cell parameters.

...

Further arguments. Currently ignored.

Details

Several types of summary are calculated and printed to the screen. If type equals "unit", a summary is given of all objects mapped to that unit. In case type equals "object", the summary indicates the unit to which the object is mapped and shows other objects mapped to it. For a type of "smoothness", the function returns the ratio of WCC values between neighbouring and non-neighbouring units. Values larger than 1 show that neighbouring units are "more alike" than non-neighbouring units. Type "quality" does something similar: it compares all data objects and takes the ratio of WCCs between objects mapped to the same unit and objects mapped to different units.

Author(s)

Ron Wehrens

See Also

wccsom

Examples

1
2
3
4
5
6
7
8
9
data(cepha)
gr <- somgrid(3,3, "hexagonal")
set.seed(7)
x <- wccsom(cepha$patterns, grid=gr, trwidth=20, rlen=100)

summary(x, "unit", nr=1, labels=paste(cepha$class.names, 1:20, sep=""))
summary(x, "object", nr=1, labels=paste(cepha$class.names, 1:20, sep=""))
summary(x, type = "smoothness")
summary(x, "quality")

wccsom documentation built on May 30, 2017, 12:52 a.m.