glmFamily-class {lme4} | R Documentation

## Class `"glmFamily"` - a reference class for `family`

### Description

This class is a wrapper class for `family` objects specifying a distibution family and link function for a generalized linear model (`glm`). The reference class contains an external pointer to a C++ object representing the class. For common families and link functions the functions in the family are implemented in compiled code so they can be accessed from other compiled code and for a speed boost.

### Extends

All reference classes extend and inherit methods from `"envRefClass"`.

### Note

Objects from this reference class correspond to objects in a C++ class. Methods are invoked on the C++ class using the external pointer in the `Ptr` field. When saving such an object the external pointer is converted to a null pointer, which is why there is a redundant field `ptr` that is an active-binding function returning the external pointer. If the `Ptr` field is a null pointer, the external pointer is regenerated for the stored `family` field.

### See Also

`family`, `glmFamily`

### Examples

    str(glmFamily$new(family=poisson()))

[Package lme4 version 1.1-12 Index]