InternalClassUnions {distrMod} | R Documentation |
Class unions in 'distrMod'
Description
Class unions in package distrMod defined for internal
purposes; these are OptionalNumeric
, OptionalMatrix
,
MatrixorFunction
, ShowDetails
Details
These classes are used internally to make available methods or to allow slots of classes to be filled with varying types. In particular
"OptionalNumericOrMatrix"
may contain objects of class
"OptionalNumeric"
or"matrix"
;"OptionalNumericOrMatrixOrCall"
may contain objects of class
"OptionalNumericOrMatrix"
or"call"
; it is used e.g. for slotasvar
of class"Estimate"
, as it may or may not be present or be a call; otherwise it has to be a number (numeric) or a matrix."OptionalDistrListOrCall"
may contain objects of class
"DistrList"
or"call"
; it is used e.g. for slotL2derivDistr
of class"L2ParamFammily"
, as it may or may not be present or be a call; otherwise it has to be a list of distributions."MatrixorFunction"
may contain objects of class
"OptionalFunction"
or"matrix"
; it is used e.g. for slottrafo
of class"ParamFamParameter"
, as it may or may not be present and if it is present, it has to either be a function or a matrix, seetrafo-methods
."ShowDetails"
may contain objects of class
"Estimate"
,"MCEstimate"
,"Confint"
,"PosSemDefSymmMatrix"
"ParamFamily"
, or"ParamFamParameter"
; used to provide sort of a “show
with extra arguments”, in form of a commonprint
method for these S4 classes, which essentially just temporarily sets the global options according to the optional argumentsdigits
andshow.details
, callsshow
and then re-sets the options to their global settings."L2LocationScaleUnion"
is a proper, but virtual in-between class between class
"L2GroupParamFamily"
and"L2LocationFamily"
,"L2ScaleFamily"
, and"L2LocationScaleFamily"
; in addition to class"L2GroupParamFamily"
it has a slotlocscalename
(with corresponding accessor and replacement method) to capture the fact that location and scale parameter may carry names other than"loc"
resp."scale"
; used to provide a common class for (parts of) methodsmodifyModel
locscalename
andlocscalename<-
."L2ScaleShapeUnion"
is a proper, but virtual in-between class between class
"L2GroupParamFamily"
and, e.g.,"GammaFamily"
,"GParetoFamily"
, and"EVDFamily"
(the latter from extension package RobExtremes; it has a slotscaleshapename
(with corresponding accessor and replacement method) to capture the fact that location and scale parameter may carry names other than"shape"
resp."scale"
; used to provide a common class for (parts of) methodsscaleshapename
andscaleshapename<-
."L2ScaleUnion"
is a class union between
"L2ScaleShapeUnion"
and"L2LocationScaleUnion"
to allow for specific general scaling methods; to this end there is methodscalename
.
Objects from the Class
All of these classes are virtual: No objects may be created from them.
Author(s)
Peter Ruckdeschel peter.ruckdeschel@uni-oldenburg.de
See Also
numeric-class
,
matrix-class
,
function-class
,
MCEstimate-class
,
Estimate-class
,
Confint-class
,
PosSemDefSymmMatrix-class
,
L2GroupParamFamily-class
,
L2LocationFamily-class
,
L2ScaleFamily-class
,
GammaFamily-class
,
L2LocationScaleFamily-class
,
ParamFamParameter-class
ParamFamily-class