coef.selm: Coefficients of objects created by 'selm'

View source: R/sn-funct.R

coef.selmR Documentation

Coefficients of objects created by selm

Description

coef method for classes "selm" and "mselm".

Usage

## S4 method for signature 'selm'
coef(object, param.type = "CP", ...)
## S4 method for signature 'mselm'
coef(object, param.type = "CP", vector=TRUE, ...)

Arguments

object

an object of class "selm" or "mselm" as created by a call to function selm.

param.type

a character string which indicates the required type of parameter type; possible values are "CP" (default), "DP", "pseudo-CP" and their equivalent lower-case expressions.

vector

a logical value (default is TRUE) which selects a vector or a list format of the retuned value

...

not used, included for compatibility with the generic method

Value

a numeric vector or a list (the latter only for mselm-class objects if vector=FALSE)

Note

The possible options of param.type are described in the documentation of dp2cp; their corresponding outcomes differ by an additive constant only. With the "CP" option (that is, the ‘centred parametrization’), the residuals are centred around 0, at least approximately; this is a reason for setting "CP" as the default option. For more information, see the ‘Note’ in the documentation of summary.selm.

Author(s)

Adelchi Azzalini

References

Azzalini, A. with the collaboration of Capitanio, A. (2014). The Skew-Normal and Related Families. Cambridge University Press, IMS Monographs series.

See Also

dp2cp, summary.selm, selm function, selm-class

Examples

 
data(wines, package="sn")
m5 <- selm(acidity ~ phenols + wine, family="SN", data=wines)
coef(m5)
coef(m5, "dp")
#
m12 <- selm(cbind(acidity, alcohol) ~ phenols + wine,  family="SN", data=wines)
coef(m12)
coef(m12, "DP", vector=FALSE)


sn documentation built on April 5, 2023, 5:15 p.m.