[Rcpp-commits] r3061 - in pkg/RcppGSL: . inst man

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

Author: edd
Date: 2011-06-14 02:16:11 +0200 (Tue, 14 Jun 2011)
New Revision: 3061

Modified:
   pkg/RcppGSL/ChangeLog
   pkg/RcppGSL/DESCRIPTION
   pkg/RcppGSL/NAMESPACE
   pkg/RcppGSL/inst/NEWS
   pkg/RcppGSL/man/fastLm.Rd
Log:
export and document S3 methods as such, with a tip-of-the-hat to Doug


Modified: pkg/RcppGSL/ChangeLog
===================================================================
--- pkg/RcppGSL/ChangeLog	2011-06-13 22:35:11 UTC (rev 3060)
+++ pkg/RcppGSL/ChangeLog	2011-06-14 00:16:11 UTC (rev 3061)
@@ -1,3 +1,8 @@
+2011-06-13  Dirk Eddelbuettel  <edd at debian.org>
+
+	* NAMESPACE: Properly export S3methods as such
+	* man/fastLm.Rd: Similar updates to help page
+
 2011-04-08  Dirk Eddelbuettel  <edd at debian.org>
 
 	* R/fastLm.R: In print.summary.fastLm(), use 'P.values' not 'P.value'

Modified: pkg/RcppGSL/DESCRIPTION
===================================================================
--- pkg/RcppGSL/DESCRIPTION	2011-06-13 22:35:11 UTC (rev 3060)
+++ pkg/RcppGSL/DESCRIPTION	2011-06-14 00:16:11 UTC (rev 3061)
@@ -1,7 +1,7 @@
 Package: RcppGSL
 Type: Package
 Title: Rcpp integration for GNU GSL vectors and matrices
-Version: 0.1.1
+Version: 0.1.1.1
 Date: $Date$
 Author: Romain Francois and Dirk Eddelbuettel
 Maintainer: Dirk Eddelbuettel and Romain Francois <RomainAndDirk at r-enthusiasts.com>

Modified: pkg/RcppGSL/NAMESPACE
===================================================================
--- pkg/RcppGSL/NAMESPACE	2011-06-13 22:35:11 UTC (rev 3060)
+++ pkg/RcppGSL/NAMESPACE	2011-06-14 00:16:11 UTC (rev 3061)
@@ -2,10 +2,10 @@
 
 importFrom(utils,assignInNamespace)
 export(fastLmPure,
-       fastLm,
-       fastLm.default,
-       fastLm.formula,
-       predict.fastLm,
-       print.fastLm,
-       summary.fastLm,
-       print.summary.fastLm)
+       fastLm)
+S3method(fastLm, default)
+S3method(fastLm, formula)
+S3method(predict, fastLm)
+S3method(print, fastLm)
+S3method(summary, fastLm)
+S3method(print, summary.fastLm)

Modified: pkg/RcppGSL/inst/NEWS
===================================================================
--- pkg/RcppGSL/inst/NEWS	2011-06-13 22:35:11 UTC (rev 3060)
+++ pkg/RcppGSL/inst/NEWS	2011-06-14 00:16:11 UTC (rev 3061)
@@ -1,3 +1,7 @@
+0.1.2   20xx-yy-zz
+
+    o   Export and document S3 methods in NAMESPACE and manual page as such
+
 0.1.1   2011-04-05
 
     o   Unit tests produce a summary vignette as for some of the other packages

Modified: pkg/RcppGSL/man/fastLm.Rd
===================================================================
--- pkg/RcppGSL/man/fastLm.Rd	2011-06-13 22:35:11 UTC (rev 3060)
+++ pkg/RcppGSL/man/fastLm.Rd	2011-06-14 00:16:11 UTC (rev 3061)
@@ -3,10 +3,6 @@
 \alias{fastLmPure}
 \alias{fastLm.default}
 \alias{fastLm.formula}
-\alias{print.fastLm}
-\alias{summary.fastLm}
-\alias{print.summary.fastLm}
-\alias{predict.fastLm}
 \concept{regression}
 \title{Bare-bones linear model fitting function}
 \description{
@@ -16,12 +12,9 @@
 \usage{
 fastLmPure(y, X)
 
-fastLm(x, ...)
-\method{fastLm}{default}(x, y, ...)
-\method{fastLm}{formula}(formula, data = list(), ...)
-\method{print}{fastLm}(x, ...)
-\method{summary}{fastLm}(object, ...)
-\method{predict}{fastLm}(object, newdata=NULL, ...)
+fastLm(x, \dots)
+\method{fastLm}{default}(x, y, \dots)
+\method{fastLm}{formula}(formula, data = list(), \dots)
 }
 \arguments{
   \item{y}{a vector containing the explained variable.}
@@ -29,9 +22,6 @@
   \item{x}{a numeric design matrix for the model.}
   \item{formula}{a symbolic description of the model to be fit.}
   \item{data}{an optional data frame containing the variables in the model.}
-  \item{newdata}{an optional data frame containing the variables for
-    which a model prediction is desired.}
-  \item{object}{an object of class \code{"fastLm"}, i.e. a fitted model}
   \item{\ldots}{not used}
 }
 \details{