rpql (version 0.8.1)

nb2: A negative binomial family

Description

Since the negative binomial is not a family in base R, an nb2() family has been created which establishes the negative binomial as a family for use in the main rpql function. Only the log link is available at the moment, with the variance parameterized as \(V = \mu + \phi\mu^2\) where \(\phi\) is the overdispersion parameter.

Usage

nb2()

Value

An object of class "family"

Author

tools:::Rd_package_author("rpql")

Maintainer: tools:::Rd_package_maintainer("rpql")

Details

Used in the form rpql(y, ..., family = nb2(), ...).

See Also

negative.binomial in the MASS package for another example of a negative.binomial family.

Examples

if (FALSE) {
## The function is currently defined as follows
nb2 <- function () {
    link <- "log"
    linkfun <- function(mu) log(mu)
    linkinv <- function(eta) pmax(exp(eta), .Machine$double.eps)
    mu.eta <- function(eta) pmax(exp(eta), .Machine$double.eps)
    variance <- function(mu, phi) mu + phi * mu^2
    valideta <- function(eta) TRUE
    validmu <- function(mu) all(mu > 0)
    structure(list(family = "negative.binomial", link = "log", 
        linkfun = linkfun, linkinv = linkinv, mu.eta = mu.eta, 
        variance = variance, valideta = valideta, validmu = validmu, 
        name = link), class = "family")
  }
}