Skip to content

Commit 58edda5

Browse files
author
maechler
committed
improved description (inspired by PR#18173 & RG)
git-svn-id: https://svn.r-project.org/R/trunk@87743 00db46b3-68df-0310-9c12-caf00c1e9a41
1 parent 296cb11 commit 58edda5

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

src/library/stats/man/lmfit.Rd

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
% File src/library/stats/man/lmfit.Rd
22
% Part of the R package, https://www.R-project.org
3-
% Copyright 1995-2023 R Core Team
3+
% Copyright 1995-2025 R Core Team
44
% Distributed under GPL 2 or later
55

66
\name{lm.fit}
@@ -19,11 +19,16 @@ lm.wfit(x, y, w, offset = NULL, method = "qr", tol = 1e-7,
1919
\alias{.lm.fit}
2020
\description{
2121
These are the basic computing engines called by \code{\link{lm}} used
22-
to fit linear models. These should usually \emph{not} be used
23-
directly unless by experienced users. \code{.lm.fit()} is a bare-bones
24-
wrapper to the innermost QR-based C code, on which
25-
\code{\link{glm.fit}} and \code{\link{lsfit}} are also based, for
26-
even more experienced users.
22+
to fit linear models. As they work directly with numeric matrices, they
23+
may be more efficient, notably in the case of performing many similar
24+
regressions or when inference is not of interest.
25+
26+
\code{\link{lm}} calls \code{lm.fit()} as a helper function.
27+
28+
\code{.lm.fit()} is a thin wrapper to the "innermost" C code performing
29+
the QR decomposition without much checking and should hence be used with
30+
care. The same C code is called by \code{lm.fit()} and also by
31+
\code{\link{glm.fit}()} and \code{\link{lsfit}()}.
2732
}
2833
\arguments{
2934
\item{x}{design matrix of dimension \code{n * p}.}

0 commit comments

Comments
 (0)