reStruct Object Coefficients

DESCRIPTION:

This method function extracts the coefficients associated with the positive-definite matrix represented by object.

USAGE:

coef(object, unconstrained) 
coef(object) <- value 

REQUIRED ARGUMENTS:

object
an object inheriting from class reStruct, representing a random effects structure and consisting of a list of pdMat objects.

OPTIONAL ARGUMENTS:

unconstrained
a logical value. If TRUE the coefficients are returned in unconstrained form (the same used in the optimization algorithm). If FALSE the coefficients are returned in "natural", possibly constrained, form. Defaults to TRUE.
value
a vector with the replacement values for the coefficients associated with object. It must be a vector with the same length of coef(object) and must be given in unconstrained form.

VALUE:

a vector with the coefficients corresponding to object.

SIDE EFFECTS::

On the left side of an assignment, sets the values of the coefficients of object to value.

SEE ALSO:

, ,

EXAMPLES:

rs1 <- reStruct(list(A = pdSymm(diag(1:3), form = ~Score), 
  B = pdDiag(2 * diag(4), form = ~Educ))) 
coef(rs1)