out |
An object of S3 class fsmeda.object returned by
fsmult with monitoring=TRUE -
a list containing the monitoring of minimum Mahalanobis distance.
The needed elements of out are
-
MAL: matrix containing the squared Mahalanobis distances monitored in each
step of the forward search. Every row is associated with a unit (row of data matrix X).
-
Un: matrix containing the order of entry of each unit
(necessary if datatooltip or databrush is selected).
-
X: The data matrix.
|
xlim |
Controls the x scale in the plot. xlim is a vector with two elements controlling
minimum and maximum on the x-axis. Default is to use automatic scale.
|
ylim |
Controls the y scale in the plot. ylim is a vector with two elements controlling
minimum and maximum on the y-axis. Default is to use automatic scale.
|
xlab |
A title for the x axis
|
ylab |
A title for the y axis, deafult is "Squared Mahalanobis distances".
|
main |
An overall title for the plot
|
lwd |
The line width, a positive number, defaulting to 1
|
lty |
The line type. Line types can either be specified as an integer (1=solid (default), 2=dashed,
3=dotted, 4=dotdash, 5=longdash, 6=twodash) or as one of the character strings "solid",
"dashed", "dotted", "dotdash", "longdash", or "twodash".
The latter two are not supported by Matlab.
|
col |
Colors to be used for the highlighted units
|
cex.lab |
The magnification to be used for x and y labels relative to the current setting of cex
|
cex.axis |
The magnification to be used for axis annotation relative to the current setting of cex
|
subsize |
Numeric vector containing the subset size with length equal to the number of columns of
matrix of mahalanobis distances. The default value of subsize is (nrow(MAL) - ncol(MAL) + 1):nrow(MAL)
|
fg.thresh |
(alternative to fg.unit) numeric vector of length 1 or 2 which specifies
the highlighted trajectories.
If length(fg.thresh) == 1 the highlighted trajectories are those of units that throughtout
the search had at leat once a mahalanobis distance greater than fg.thresh.
The default value is fg.thresh=2.5. If length(fg.thresh) == 2 the highlighted
trajectories are those of units that throughtout the search had a mahalanobis distance at
least once bigger than fg.thresh[2] or smaller than fg.thresh[1].
|
fg.unit |
(alternative to fg.thresh), vector containing the list of the units to be highlighted.
If fg.unit is supplied, fg.thresh is ignored.
|
fg.labstep |
numeric vector which specifies the steps of the search where to put labels for
the highlighted trajectories (units). The default is to put the labels at the
initial and final steps of the search. fg.labstep='' means no label.
|
fg.lwd |
The line width for the highlighted trajectories (units). Default is 1.
|
fg.lty |
The line type for the highlighted trajectories (units). Line types can
either be specified as an integer (1=solid (default), 2=dashed,
3=dotted, 4=dotdash, 5=longdash, 6=twodash) or as one of the character strings "solid",
"dashed", "dotted", "dotdash", "longdash", or "twodash".
The latter two are not supported by Matlab.
|
fg.col |
colors to be used for the highlighted units.
|
fg.mark |
Controlls whether to plot highlighted trajectories as symbols.
if fg.mark==TRUE each line is plotted using a different
symbol else no marker is used (default).
|
fg.cex |
Controls the font size of the labels of the trajectories in foreground. If
fg.cex=0 no labels will be shown - equivalent to fg.labstop="".
|
bg.thresh |
Numeric vector of length 1 or 2 which specifies how to define the unimmportant trajectories.
Unimmportant trajectories will be plotted using a colormap, in greysh or will be hidden.
If length(bg.thresh) == 1 the irrelevant units are those which always
had a mahalanobis distance smaller than bg.thresh.
If length(bg.thresh) == 2 the irrelevant units are those which always
had a mahalanobis distance greater than bg.thresh[1] and smaller than bg.thresh[2].
The default is bg.thresh=2.5 if n > 100 and bg.thresh=-Inf if n <= 100
i.e. to treat all trajectories as important if n <= 100 and, if n > 100,
to reduce emphasis only to trajectories having in all steps of the search a value
of mahalanobis distance smaller than 2.5.
|
bg.style |
Specifies how to plot the unimportant trajectories as defined in option bg.thresh.
-
bg.style="faint": unimportant trajectories are plotted using a colormap.
-
bg.style="hide": unimportant trajectories are hidden.
-
bg.style="greyish": unimportant trajectories are displayed in a faint grey.
When n > 100 the default option is bg.style='faint'. When n <= 100
and bg.thresh == -Inf option bg.style is ignored.
Remark: bground=” is equivalent to -Inf that is all trajectories are considered relevant.
|
standard |
MATLAB-style arguments - appearance of the plot in terms of xlim, ylim, axes labels
and their font size style, color of the lines, etc.
|
fground |
MATLAB-style arguments - for the trajectories in foregroud.
|
bground |
MATLAB-style arguments - for the trajectories in backgroud.
|
tag |
Plot handle. String which identifies the handle of the plot which is about to be created.
The default is to use tag 'pl_resfwd'. Notice that if the program finds a plot which has
a tag equal to the one specified by the user, then the output of the new plot overwrites
the existing one in the same window else a new window is created.
|
datatooltip |
Interactive clicking. It is inactive if this parameter is set to FALSE.
The default is datatooltip=TRUE, the user can select with the mouse an individual
mahalanobis distance trajectory in order to have information about the corresponding unit, the associated
label and the step of the search in which the unit enters the subset.
If datatooltip is a list it may contain the following fields:
DisplayStyle determines how the data cursor displays. Possible values are
'datatip' and 'window' (default). 'datatip' displays
data cursor information in a small yellow text box attached to a black
square marker at a data point you interactively select. 'window'
displays data cursor information for the data point you interactively
select in a floating window within the figure.
SnapToDataVertex: specifies whether the data cursor snaps to the nearest data value or
is located at the actual pointer position.
Possible values are SnapToDataVertex='on' (default) and SnapToDataVertex='off'.
LineColor: controls the color of the trajectory selected with the mouse. It can be an RGB triplet
of values between 0 and 1, or character vector indicating a color name. Note that a RGB vector
can be conveniently chosen with our MATLAB class FSColor, see documentation.
SubsetLinesColor: enables to control the color of the trajectories of the units that are
in the subset at a given step of the search (if resfwdplot() is applied to an
object of class fsreda.object) or have a weight greater than 0.9 (if
resfwdplot() is applied to an object of class sregeda.object
or mmregeda.object). This can be done (repeatedly) with a left mouse
click in proximity of the step of interest. A right mouse click will terminate the
selection by marking with a up-arrow the step corresponding to the highlighted
lines. The highlighted lines by default are in red, but a different color can be
specified as RGB triplet or character of color name. Note that a RGB vector can
be conveniently chosen with our MATLAB class FSColor, see documentation.
By default SubsetLinesColor="", i.e. the modality is not active.
Any initialization for SubsetLinesColor which cannot be interpreted as
RGB vector will be converted to blue, i.e. SubsetLinesColor will be forced to be [0 0 1].
If SubsetLinesColor is not empty the previous option LineColor is ignored.
|
label |
Character vector containing the labels of the units (optional argument used when
datatooltip=TRUE. If this field is not present labels
row1, ..., rown will be automatically created and included
in the pop up datatooltip window).
|
nameX |
Add variable labels in plot. A vector of strings of length p
containing the labels of the variables in the dataset.
If it is empty (default) the sequence X1, ..., Xp will be created automatically
|
databrush |
Interactive mouse brushing. If databrush is missing or empty (default), no brushing is done.
The activation of this option (databrush is TRUE or a list) enables the user to select
a set of trajectories in the current plot and to see them highlighted in the scatterplot matrix.
If the scatterplot matrix does not exist it is automatically created.
In addition, brushed units can be highlighted in the monitoring mahalanobis distance plot.
Note that the window style of the other figures is set equal to that which contains the monitoring mahalanobis distance plot.
In other words, if the monitoring mahalanobis distance plot is docked all the other figures will be docked too.
If databrush=TRUE the default selection tool is a rectangular brush and it is
possible to brush only once (that is persist=”).
If databrush=list(...), it is possible to use all optional arguments of
the MATLAB function selectdataFS() and the following optional arguments:
persist. Persist is an empty value or a character containing 'on' or 'off'.
The default value is persist="", that is brushing is allowed only once.
If persist="on" or persis="off" brushing can be done as many time as
the user requires. If persist='on' then the unit(s) currently brushed are
added to those previously brushed. It is possible, every time a new brushing is
done, to use a different color for the brushed units. If persist='off'
every time a new brush is performed units previously brushed are removed.
-
label: add labels of brushed units in the monitoring plot.
-
labeladd: add labels of brushed units in the scatterplot matrix.
If this option is '1', we label the units of the last selected group with
the unit row index in the matrix X. The default value is labeladd=”,
i.e. no label is added.
|
conflev |
confidence interval for the horizontal bands. It can be a vector of
different confidence level values, e.g. c(0.95, 0.99, 0.999).
The confidence interval is based on the $chi^2$ distribution.
|
trace |
Whether to print intermediate results. Default is trace=FALSE.
|
... |
potential further arguments passed to lower level functions.
|
Atkinson A.C., Riani M. and Cerioli A. (2004), Exploring Multivariate Data with the Forward Search, Springer Verlag, New York.