ParamFamParameter: Generating function for ParamFamParameter-class

In distrMod: Object Oriented Implementation of Probability Models

Generating function for ParamFamParameter-class

Description

Generates an object of class "ParamFamParameter".

Usage

ParamFamParameter(name, main = numeric(0), nuisance, fixed, trafo,
                  ..., .returnClsName = NULL)

Arguments

name	(optional) character string: name of parameter
main	numeric vector: main parameter
nuisance	(optional) numeric vector: nuisance paramter
fixed	(optional) numeric vector: fixed part of the paramter
trafo	(optional) MatrixorFunction: transformation of the parameter
...	(optional) additional arguments for further return classes, e.g.\ withPosRestr (only use case so far) for class ParamWithShapeFamParameter
.returnClsName	character or NULL; if non-null, the generated object will be of class .returnClsName, which must be a subclass of ParamFamParameter.

Details

If name is missing, the default “"parameter of a parametric family of probability measures"” is used. If nuisance is missing, the nuisance parameter is set to NULL. The number of columns of trafo have to be equal and the number of rows have to be not larger than the sum of the lengths of main and nuisance. If trafo is missing, no transformation to the parameter is applied; i.e., trafo is set to an identity matrix.

Value

Object of class "ParamFamParameter" (or, if non-null, of class .returnClsName)

Author(s)

Matthias Kohl [e-mail],
Peter Ruckdeschel [e-mail]

See Also

ParamFamParameter-class

Examples

ParamFamParameter(main = 0, nuisance = 1, fixed = 2,
                  trafo = function(x) list(fval = sin(x), 
                                            mat = matrix(cos(x),1,1))
                  )                          

distrMod documentation built on Jan. 12, 2025, 3:01 a.m.