Class S2.class — S2.class-class • adegraphics

A class for group representation in bi-dimensional plot.

Objects from the Class

S2.class objects can be created by calls of the form new("S2.class", ...).

The regular usage in this package is to use the s.class function.

Slots

data

a list containing data or data's name.

dfxy: the displayed values in the form of a data frame, a name or a matching call.
fac: a factor (or a matrix of factors) splitting the rows of dfxy.
xax: an integer or a vector indicating the columns of dfxy kept for the x-axes.
yax: an integer or a vector indicating the columns of dfxy kept for the y-axes.
wt: a vector of weights for fac.
labels: a vector containing the class' labels.
frame: a positive or null integer. It is the number of the frame containing the data (used with sys.frame(..., env = data$frame)). Only if the data are not stored (i.e. data$storeData = FALSE).
storeData: a logical indicating if the data should be stored in the returned object. If FALSE, only the names of the data arguments are stored.

trellis.par

a list of parameters for lattice call. It will be passed directly to par.settings arguments of the lattice function.

adeg.par

a list of graphical parameters, corresponding to the ones given by adegpar() function.

lattice.call

a list to create the trellis object.

g.args

a list containing some method parameters linked with the created object of ADEg.S2 class. The specific slots for S2.class objects are:

ellipseSize: a positive number for ellipse size.
starSize: a number between 0 and 1 for star size.
chullSize: NULL or a vector of numbers between 0 and 1 for the convex hulls.
col: a logical or a vector of colors that apply to points, ellipses, labels, lines and polygons.

stats

a list of internal preliminary calculations. The specific slots for S2.class objects are:

means: a matrix containing the weighted mean calculated for each fac value.
covvar: a list containing the weighted variance-covariance matrices calculated for each fac value.

s.misc

a list of some others internal parameters:

ellipses: ellipses' coordinates.
chullcoord: convex hulls' coordinates.

Call

an object of class call

Extends

Class ADEg.S2, directly.
Class ADEg, by class ADEg.S2, distance 2.
Class ADEgORtrellis, by class ADEg.S2, distance 3.
Class ADEgORADEgSORtrellis, by class ADEg.S2, distance 3.

Methods

The methods of the father classes "ADEg.S2" and "ADEg" can be used by inheritance. The specific methods for S2.class are:

prepare: signature(object = "S2.class"): calls the parent method (prepare for ADEg.S2), modifies some graphical parameters used by default and calculates ellipses, convex hulls and centroids.
panel: signature(object = "S2.class"): draws ellipses, convex hulls, stars, labels and points.

Author

Alice Julien-Laferriere, Aurelie Siberchicot aurelie.siberchicot@univ-lyon1.fr and Stephane Dray

Examples

showClass("S2.class")
#> Class "S2.class" [package "adegraphics"]
#> 
#> Slots:
#>                                                                        
#> Name:          data  trellis.par     adeg.par lattice.call       g.args
#> Class:         list         list         list         list         list
#>                                              
#> Name:         stats       s.misc         Call
#> Class:         list         list         call
#> 
#> Extends: 
#> Class "ADEg.S2", directly
#> Class "ADEg", by class "ADEg.S2", distance 2
#> Class "ADEgORtrellis", by class "ADEg.S2", distance 3
#> Class "ADEgORADEgSORtrellis", by class "ADEg.S2", distance 3

Class `S2.class`