R: Special Values or Quantities in a Fitted Object

specials {VGAM} | R Documentation

## Special Values or Quantities in a Fitted Object

### Description

Return any special values or quantities in a fitted object, and in particular in a VGLM fit

### Usage

    specials(object, ...)
    specialsvglm(object, ...)

### Arguments

`object` | an object of class `"vglm"`.
`...` | any additional arguments, to future-proof this function.

### Details

This extractor function was motivated by GAIT regression (Yee and Ma, 2020) where the values from three disjoint sets are referred to as special. More generally, S4 methods functions can be written so that `specials()` will work on any S4 object, where what is called special depends on the methodology at hand.

### Value

Returns any ‘special’ values or quantities associated with a fitted regression model. This is often something simple such as a list or a vector.

### References

Yee, T. W. and Ma, C. (2020). Generally–altered, –inflated and –truncated regression, with application to heaped and seeped count data. In preparation.

### See Also

`vglm`, `vglm-class`, `inflated`, `altered`, `truncated`.

### Examples

    abdata <- data.frame(y = 0:7, w = c(182, 41, 12, 2, 2, 0, 0, 1))
    fit1 <- vglm(y ~ 1, gaitpoisson.mix(inflate  = 1), abdata,
                 weight = w, subset = w > 0)
    specials(fit1)

[Package VGAM version 1.1-3 Index]