coef.pdCompSymm {nlme}R Documentation

pdCompSymm 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

Arguments

object an object inheriting from class pdCompSymm, representing a positive-definite matrix with compound symmetry structure.
unconstrained a logical value. If TRUE the coefficients are returned in unconstrained form (the same used in the optimization algorithm). If FALSE the standard deviation and the correlation coefficient of the compound symmetry of positive-definite matrix represented by object are returned. Defaults to TRUE.
value a vector with the replacement values for the coefficients associated with object. It must be a vector of length two and must be given in unconstrained form.
... some methods for this generic require additional arguments. None are used in this method.

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. Object must be initialized (using Initialize) before new values can be assigned to its coefficients.

Author(s)

Jose Pinheiro and Douglas Bates

See Also

coef.pdMat, pdMat

Examples

coef(pdCompSymm(diag(3)), FALSE)

[Package Contents]