[Dplr-commits] r773 - in pkg/dplR: . man

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

Author: mvkorpel
Date: 2014-04-07 09:49:38 +0200 (Mon, 07 Apr 2014)
New Revision: 773

Modified:
   pkg/dplR/DESCRIPTION
   pkg/dplR/TODO
   pkg/dplR/man/rwl.stats.Rd
Log:
Updated documentation of rwl.stats() / summary.rwl().  Andy: I believe
there is no way around '...'.  All arguments of a generic function
need to be included in a method implementing the generic.  They also
need to be documented, whether used or not (and this can also be
documented...).


Modified: pkg/dplR/DESCRIPTION
===================================================================
--- pkg/dplR/DESCRIPTION	2014-04-07 05:10:12 UTC (rev 772)
+++ pkg/dplR/DESCRIPTION	2014-04-07 07:49:38 UTC (rev 773)
@@ -3,7 +3,7 @@
 Type: Package
 Title: Dendrochronology Program Library in R
 Version: 1.6.0
-Date: 2014-04-05
+Date: 2014-04-07
 Authors at R: c(person("Andy", "Bunn", role = c("aut", "cph",
         "cre", "trl"), email = "andy.bunn at wwu.edu"), person("Mikko",
         "Korpela", role = c("aut", "trl")), person("Franco", "Biondi",

Modified: pkg/dplR/TODO
===================================================================
--- pkg/dplR/TODO	2014-04-07 05:10:12 UTC (rev 772)
+++ pkg/dplR/TODO	2014-04-07 07:49:38 UTC (rev 773)
@@ -4,11 +4,6 @@
 *  In detrend(method=“ModNegExp”) there should be a verbose option that writes 
    how each series was handled including the parameters of the model.
 
-o [mvkorpel] Look at Rd page for rwl.stats. Is there a way to not include
-  dots as an argument to summary.rwl? The function rwl.stats() doesn't use
-  dots. But I can't leave them out of the \usage section or R CMD check 
-  complains.
-
 o [mvkorpel] Fix the sty file so that Sweave code adheres to the margins. And
   what is the best way to make the figure widths take up the text width?
   In addition to my many other failings, I'm not great at LaTeX!

Modified: pkg/dplR/man/rwl.stats.Rd
===================================================================
--- pkg/dplR/man/rwl.stats.Rd	2014-04-07 05:10:12 UTC (rev 772)
+++ pkg/dplR/man/rwl.stats.Rd	2014-04-07 07:49:38 UTC (rev 773)
@@ -9,24 +9,32 @@
 \usage{
 rwl.stats(object)
 
-\method{summary}{rwl}(object,...)
+\method{summary}{rwl}(object, ...)
 
 }
 \arguments{
+
   \item{object}{ a \code{rwl} object with (usually) raw ring-width series
   as columns and years as rows such as that produced by
   \code{\link{read.rwl}}.  It is sometimes desirable to run this on
   detrended (e.g., rwi) data. }
 
-  \item{\dots}{ Additional arguemnts for summary.default. Does this have
-  to be here? If this item is not included, R CMD check gives a warning. }
+  \item{\dots}{ Additional arguments from the generic function.  These
+    are silently ignored. }
+
 }
 
 \details{
+
   This calculates a variety of descriptive statistics commonly used in
   dendrochronology (see below). Users unfamiliar with these should see
   Cook and Kairiukstis (1990) and Fritts (2001) for further details.
+
+  The \code{\link{summary}} method for class \code{"rwl"} is a wrapper
+  for \code{rwl.stats}.
+  
 }
+
 \value{
   A \code{data.frame} containing descriptive stats on each
   \code{"series"}. These are the first and last year of the series as