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

A class for the creation and display of bi-dimensional plot with density estimation.

Objects from the Class

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

The regular usage in this package is to use the s.density 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.
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.density objects are:

bandwidth: bandwidth for density calculations which is passed in parameters in the bkde2D function of the KernSmooth package.
gridsize: grid dimension.
threshold: a value between 0 and 1 to draw densities greater than this threshold. No density is visible whether it is equal to 1.
col: a NULL value, a color or a colors vector to color densities.
nrpoints: number of points on the density image.
contour: a logical to draw contour lines.
region: a logical to fill grid regions with col.
nclass: number of class for density.

stats

a list of internal preliminary calculations. The specific slot for S2.density objects is:

densit: a list containing the results of the bkde2D function.

s.misc

a list of some others internal parameters

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

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

Author

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

Examples

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