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

A class for the creation and display of bi-dimensional plot with a third value represented (as a variable) by symbols.

Objects from the Class

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

The regular usage in this package is to use the s.value 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.
z: a vector (or a matrix) with as many values as rows in 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.
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.value objects are:

method: the method of representation for z (color shading or proportional size).
symbol: the type of symbol (square or circle).
center: a center value for method size.
centerpar: a logical or a list to represent center value using elements in the adegpar("ppoints") list.
breaks: a vector containing the breaks used for splitting z value. If NULL, pretty(z, n) is used.
nclass: an integer for the number of desired intervals, ignored if breaks is not missing.
col: a NULL value, a color or a colors vector to color symbols.

stats

a list of internal preliminary calculations

s.misc

a list of some others internal parameters:

plegend.update: a logical indicating if the legend parameters are updating
breaks.update: a logical indicating if the legend breaks are updating
lim.update: a logical indicating if the limits are updating

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.value are:

prepare: signature(object = "S2.value"): calls the parent method (prepare for ADEg.S2), modifies some graphical parameters used by default and calculates limits.
panel: signature(object = "S2.value"): draws symbols.

Note

For the symbol size, if the method is size, we use perceptual scaling (Tanimura et al. 2006).

References

Tanimura, S. and Kuroiwa, C. and Mizota, T. 2006. Proportional symbol mapping in R. Journal of Statistical Software. 15, 1–7

Author

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

Examples

showClass("S2.value")
#> Class "S2.value" [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.value`