[Rcpp-commits] r1241 - in pkg: RcppArmadillo/man RcppGSL/man

[noreply at r-forge.r-project.org]

Author: edd
Date: 2010-05-14 04:16:27 +0200 (Fri, 14 May 2010)
New Revision: 1241

Modified:
   pkg/RcppArmadillo/man/fastLm.Rd
   pkg/RcppGSL/man/fastLm.Rd
Log:
fixes to the manual pages


Modified: pkg/RcppArmadillo/man/fastLm.Rd
===================================================================
--- pkg/RcppArmadillo/man/fastLm.Rd	2010-05-14 02:09:32 UTC (rev 1240)
+++ pkg/RcppArmadillo/man/fastLm.Rd	2010-05-14 02:16:27 UTC (rev 1241)
@@ -38,13 +38,13 @@
   Linear models should be estimated using the \code{\link{lm}} function. In
   some cases, \code{\link{lm.fit}} may be appropriate.
 
-  This function provides a reference use case of the \code{Armadillo}
-  library.
+  The \code{fastLmCall} function provides a reference use case of the \code{GSL}
+  library via the wrapper functions in the \pkg{RcppGSL} package.
+  
+  The \code{fastLm} function provides a more standard implementation of
+  a linear model fit, offering both a default and a formula interface as
+  well as \code{print}, \code{summary} and \code{predict} methods.
 
-  It does not provide a formula interface. It does check for missing
-  values. It does (yet?) return a proper object with suitable accessor
-  functions. That's why we call it bare-bones.
-
   Lastly, one must be be careful in timing comparisons of
   \code{\link{lm}} and friends versus this approach based on
   \code{Armadillo}. The reason that \code{Armadillo} can do something
@@ -61,13 +61,15 @@
   algebra software.
 }
 \value{
-  \code{fastLm} returns a list with two components:
+  \code{fastLm} returns a list with four components:
   \item{coefficients}{a vector of coefficients}
   \item{stderr}{a vector of the (estimated) standard errors of the coefficient estimates}
-
-  In other words, no actual \sQuote{fastLm} object is provided unlike
-  for \code{\link{lm}} or \code{\link[MASS]{rlm}} but rather just a
-  simple list unlike \code{\link{lm.fit}}.
+  \item{vcov}{the covariance matrix of the estimates}
+  \item{df}{a scalar denoting the degrees of freedom in the model}
+ 
+  \code{fastLm} returns a richer object which also includes the
+  residuals and call similar to the \code{\link{lm}} or
+  \code{\link[MASS]{rlm}} functions..
 }
 \seealso{\code{\link{lm}}, \code{\link{lm.fit}}} 
 \references{Armadillo project: \url{http://arma.sourceforge.net/}}

Modified: pkg/RcppGSL/man/fastLm.Rd
===================================================================
--- pkg/RcppGSL/man/fastLm.Rd	2010-05-14 02:09:32 UTC (rev 1240)
+++ pkg/RcppGSL/man/fastLm.Rd	2010-05-14 02:16:27 UTC (rev 1241)
@@ -38,13 +38,13 @@
   Linear models should be estimated using the \code{\link{lm}} function. In
   some cases, \code{\link{lm.fit}} may be appropriate.
 
-  This function provides a reference use case of the \code{GSL}
+  The \code{fastLmCall} function provides a reference use case of the \code{GSL}
   library via the wrapper functions in the \pkg{RcppGSL} package.
+  
+  The \code{fastLm} function provides a more standard implementation of
+  a linear model fit, offering both a default and a formula interface as
+  well as \code{print}, \code{summary} and \code{predict} methods.
 
-  It does not provide a formula interface. It does check for missing
-  values. It does (yet?) return a proper object with suitable accessor
-  functions. That's why we call it bare-bones.
-
   Lastly, one must be be careful in timing comparisons of
   \code{\link{lm}} and friends versus this approach based on \code{GSL}
   or \code{Armadillo}. The reason that \code{GSL} or \code{Armadillo} can
@@ -59,17 +59,18 @@
   \dQuote{pivot only on (apparent) rank deficiency} and numerical
   analysts have no idea why statisticians want this so it is not part of
   conventional linear algebra software.
-
 }
 
 \value{
-  \code{fastLm} returns a list with two components:
-  \item{coefficients}{a vector of coefficients} \item{stderr}{a vector
-  of the (estimated) standard errors of the coefficient estimates}
-
-  In other words, no actual \sQuote{fastLm} object is provided unlike
-  for \code{\link{lm}} or \code{\link[MASS]{rlm}} but rather just a
-  simple list unlike \code{\link{lm.fit}}.
+  \code{fastLmCall} returns a list with four components:
+  \item{coefficients}{a vector of coefficients}
+  \item{stderr}{a vector of the (estimated) standard errors of the coefficient estimates}
+  \item{vcov}{the covariance matrix of the estimates}
+  \item{df}{a scalar denoting the degrees of freedom in the model}
+  
+  \code{fastLm} returns a richer object which also includes the
+  residuals and call similar to the \code{\link{lm}} or
+  \code{\link[MASS]{rlm}} functions..
 }
 \seealso{\code{\link{lm}}, \code{\link{lm.fit}}} 
 \references{GNU GSL project: \url{http://www.gnu.org/software/gsl}}