\HeaderA{negative.binomial}{Family function for Negative Binomial GLMs}{negative.binomial}
\keyword{regression}{negative.binomial}
\keyword{models}{negative.binomial}
\begin{Description}\relax
Specifies the information required to fit a Negative Binomial generalized
linear model, with known \code{theta} parameter, using \code{glm()}.
\end{Description}
\begin{Usage}
\begin{verbatim}
negative.binomial(theta = stop("'theta' must be specified"), link = "log")
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{theta}] The known value of the additional parameter, \code{theta}.

\item[\code{link}] The link function, as a character string, name or one-element
character vector specifying one of \code{log}, \code{sqrt}
or \code{identity}, or an object of class
\code{"\LinkA{link-glm}{family}"}.

\end{ldescription}
\end{Arguments}
\begin{Value}
An object of class \code{"family"}, a list of functions and
expressions needed by \code{glm()} to fit a Negative Binomial
generalized linear model.
\end{Value}
\begin{References}\relax
Venables, W. N. and Ripley, B. D. (1999)
\emph{Modern Applied Statistics with S-PLUS.} Third
Edition. Springer.
\end{References}
\begin{SeeAlso}\relax
\code{\LinkA{glm.nb}{glm.nb}}, \code{\LinkA{anova.negbin}{anova.negbin}},
\code{\LinkA{summary.negbin}{summary.negbin}}
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
# Fitting a Negative Binomial model to the quine data
#   with theta = 2 assumed known.
#
glm(Days ~ .^4, family = negative.binomial(2), data = quine)
\end{ExampleCode}
\end{Examples}

