File: updateMu.Rd

package info (click to toggle)
r-cran-matrixmodels 0.5-4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 168 kB
  • sloc: makefile: 2
file content (52 lines) | stat: -rw-r--r-- 1,595 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
\name{updateMu}
\title{Update 'mu', the Fitted Mean Response}
\alias{updateMu}
\alias{updateMu-methods}
\alias{updateMu,glmRespMod,numeric-method}
\alias{updateMu,nglmRespMod,numeric-method}
\alias{updateMu,nlsRespMod,numeric-method}
\alias{updateMu,respModule,numeric-method}
\usage{
updateMu(respM, gamma, \dots)
}
\arguments{
  \item{respM}{a response module, see the
    \code{\linkS4class{respModule}} class.}
  \item{gamma}{the value of the linear predictor before adding the offset}
  \item{\dots}{potentially further arguments used in methods; not used
    currently.}
}
\description{
  Updates the mean vector \eqn{\mu} given the linear predictor
  \eqn{\gamma}.  Evaluate the residuals and the weighted sum of squared
  residuals.
}
\details{
  Note that the offset is added to the linear predictor before
  calculating mu.

  The sqrtXwt matrix can be updated but the sqrtrwt should not be in
  that the weighted sum of squared residuals should be calculated
  relative to fixed weights.  Reweighting is done in a separate call.
}
\value{updated \code{respM}}
\section{Methods}{
  \describe{
    \item{\code{signature(respM = "glmRespMod", gamma = "numeric")}}{ .. }
    \item{\code{signature(respM = "nglmRespMod", gamma = "numeric")}}{ .. }
    \item{\code{signature(respM = "nlsRespMod", gamma = "numeric")}}{ .. }
    \item{\code{signature(respM = "respModule", gamma = "numeric")}}{ .. }
  }
}
% \references{
% }
\seealso{
  The \code{\linkS4class{respModule}} class (and specific subclasses);
  \code{\link{glm4}}.
}
\examples{
## TODO
}
\keyword{regression}
\keyword{methods}