ADEg.S1-class: Class 'ADEg.S1'

ADEg.S1-classR Documentation

Class ADEg.S1

Description

An object of ADEg.S1 class represents unidimensional data into one dimension.

The ADEg.S1 class is a virtual class, i.e. a class which is not possible to create objects but which have heirs. This class inherits from ADEg class and has five son classes : S1.boxplot, S1.class, S1.distri, S1.label and S1.match.

Objects from the Class

None object of this class can be instantiated.

Slots

data

a list containing data or data's name.

  • score: the displayed values in the form of a numeric vector, a name or a matching call.

  • at: the index value.

  • 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 of two elements to create the trellis object:

  • graphictype: xyplot

  • arguments: its parameters to obtain the trellis object

g.args

a list containing some method parameters linked with the created object of ADEg.S1 class.

stats

a list of internal preliminary calculations

s.misc

a list of some others internal parameters:

  • hori.update: a logical indicating if the sense of direction of the graphics is updating

  • backgrid: a list of two elements for grid lines. backgrid$x defines the coordinates of the lines (horizontal or vertical depending on the graphics orientation) and backgrid$d the grid mesh

  • rug: an index value indicating where the rugs are drawn

Call

an object of class call

Extends

Class ADEg, directly.

Methods

prepare

signature(object = "ADEg.S1"): performs the calculations before display the object (e.g. limits, grid and axis calculations)

setlatticecall

signature(object = "ADEg.S1"): prepares the lattice.call slot

panelbase

signature(object = "ADEg.S1"): defines the graphical background (e.g. grid, rugs and box)

gettrellis

signature(object = "ADEg.S1"): converts the graphic into a trellis object of lattice class

zoom

signature(object = "ADEg.S1", zoom = "numeric", center = "missing"): performs a zoom in (if zoom < 1) or out (if zoom > 1) centered, only in one-dimension

zoom

signature(object = "ADEg.S1", zoom = "numeric", center = "numeric"): performs a zoom in (if zoom < 1) or out (if zoom > 1) around the center passed in parameter, only in one-dimension

Note

Various graphical parameters are used for display an ADEg.S1 object. The list p1d in adegpar() is thought specific for ADEg.S1 objects.

The ADEg.S1 class and ADEg.C1 class are both used to represent an unidimensional information (e.g. a score). The difference between these two classes is mainly ideological : an ADEg.S1 object is a representation into one dimension (e.g. one line) while an ADEg.C1 object is a representation into two dimensions (e.g. curves).

Author(s)

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

See Also

adegpar zoom S1.boxplot S1.class S1.distri S1.label S1.match ADEg

Examples

showClass("ADEg.S1")
adegpar("p1d")

sdray/adegraphics documentation built on July 26, 2024, 1:25 a.m.