[Analogue-commits] r408 - in pkg: inst man

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

Author: gsimpson
Date: 2014-02-14 23:43:03 +0100 (Fri, 14 Feb 2014)
New Revision: 408

Modified:
   pkg/inst/ChangeLog
   pkg/man/performance.Rd
Log:
two further changes that should have gone with r407; documentation tweaked for performance()

Modified: pkg/inst/ChangeLog
===================================================================
--- pkg/inst/ChangeLog	2014-02-14 22:40:45 UTC (rev 407)
+++ pkg/inst/ChangeLog	2014-02-14 22:43:03 UTC (rev 408)
@@ -8,6 +8,9 @@
 	* predict.pcr: would set argument `ncomp` incorrectly (in the
 	wrong form) if not supplied.
 
+	* performance.crossval: A new emthod for objects of class
+	`"crossval"`.
+
 Version 0.13-3 Opened 11 Feb 2014
 
 	* timetrack: A number of additions added and improvements made:

Modified: pkg/man/performance.Rd
===================================================================
--- pkg/man/performance.Rd	2014-02-14 22:40:45 UTC (rev 407)
+++ pkg/man/performance.Rd	2014-02-14 22:43:03 UTC (rev 408)
@@ -4,6 +4,7 @@
 \alias{performance.wa}
 \alias{performance.predict.wa}
 \alias{performance.bootstrap.wa}
+\alias{performance.crossval}
 \title{Transfer function model performance statistics}
 \description{
   A simple extractor function to access the model performance statistics
@@ -11,20 +12,26 @@
 }
 \usage{
 performance(object, ...)
-
-\method{performance}{wa}(object, ...)
-
-\method{performance}{predict.wa}(object, ...)
-
-\method{performance}{bootstrap.wa}(object, ...)
 }
 \arguments{
   \item{object}{A transfer function object.}
   \item{\dots}{Arguments passed to other methods. Currently ignored.}
 }
-%\details{
-%  ~~ If necessary, more details than the description above ~~
-%}
+\details{
+  \code{performance} is a generic function for use with a number of
+  fitted models objects in \pkg{analogue}. The available methods are:
+
+  \itemize{
+    \item{\code{\link{wa}}}{Weighted Averaging Models.}
+    \item{\code{\link{predict.wa}}}{Predictions from a Weighted Average
+      Model.}
+    \item{\code{\link{pcr}}}{Principal Component Regression models.}
+    \item{\code{\link{bootstrap.wa}}}{Bootstrapped Weighted Averaging
+      Models.}
+    \item{\code{\link{crossval}}}{Cross-validated models fitted via
+      \code{\link{crossval}}.}
+  }
+}
 \value{
   A named vector containing the extracted model performance statistics.
 }