S2.density-class {adegraphics} | R Documentation |
Class S2.density
Description
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 ofdfxy
kept for the x-axes.yax
: an integer or a vector indicating the columns ofdfxy
kept for the y-axes.frame
: a positive or null integer. It is the number of the frame containing the data (used withsys.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. IfFALSE
, only the names of the data arguments are stored.
trellis.par
a list of parameters for
lattice
call. It will be passed directly topar.settings
arguments of thelattice
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 forS2.density
objects are:bandwidth
: bandwidth for density calculations which is passed in parameters in thebkde2D
function of theKernSmooth
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
: aNULL
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 withcol
.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 thebkde2D
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
forADEg.S2
), modifies some graphical parameters used by default and calculates densities.- panel
signature(object = "S2.density")
: draws densities and external points.
Author(s)
Alice Julien-Laferriere, Aurelie Siberchicot aurelie.siberchicot@univ-lyon1.fr and Stephane Dray
See Also
Examples
showClass("S2.density")