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

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

Author: mvkorpel
Date: 2015-06-03 11:24:56 +0200 (Wed, 03 Jun 2015)
New Revision: 994

Modified:
   pkg/dplR/DESCRIPTION
   pkg/dplR/R/treeMean.R
   pkg/dplR/man/read.compact.Rd
   pkg/dplR/man/read.fh.Rd
   pkg/dplR/man/read.rwl.Rd
   pkg/dplR/man/read.tucson.Rd
   pkg/dplR/man/treeMean.Rd
Log:
Changes as suggested by Andy:
* Class of return value, c("rwl", "data.frame"), is documented where
  appropriate.
* In treeMean(), stop() when missing tree IDs are detected.


Modified: pkg/dplR/DESCRIPTION
===================================================================
--- pkg/dplR/DESCRIPTION	2015-06-02 19:43:07 UTC (rev 993)
+++ pkg/dplR/DESCRIPTION	2015-06-03 09:24:56 UTC (rev 994)
@@ -3,7 +3,7 @@
 Type: Package
 Title: Dendrochronology Program Library in R
 Version: 1.6.4
-Date: 2015-06-02
+Date: 2015-06-03
 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/R/treeMean.R
===================================================================
--- pkg/dplR/R/treeMean.R	2015-06-02 19:43:07 UTC (rev 993)
+++ pkg/dplR/R/treeMean.R	2015-06-03 09:24:56 UTC (rev 994)
@@ -19,7 +19,7 @@
     }
     uTrees <- unique(trees)
     if (any(is.na(uTrees))) {
-        warning("series with missing tree IDs, will be averaged")
+        stop("missing tree IDs are not allowed")
     }
     matches <- match(trees, uTrees)
     res <- matrix(NA_real_, nrow=nrow(rwl2), ncol=length(uTrees))

Modified: pkg/dplR/man/read.compact.Rd
===================================================================
--- pkg/dplR/man/read.compact.Rd	2015-06-02 19:43:07 UTC (rev 993)
+++ pkg/dplR/man/read.compact.Rd	2015-06-03 09:24:56 UTC (rev 994)
@@ -19,9 +19,9 @@
   format.
 }
 \value{
-  A \code{data.frame} with the series in columns and the years as
-  rows.  The series \acronym{ID}s are the column names and the years are
-  the row names.
+  An object of class \code{c("rwl", "data.frame")} with the series in
+  columns and the years as rows.  The series \acronym{ID}s are the
+  column names and the years are the row names.
 }
 \author{ Mikko Korpela }
 \seealso{ \code{\link{read.rwl}}, \code{\link{read.tucson}},

Modified: pkg/dplR/man/read.fh.Rd
===================================================================
--- pkg/dplR/man/read.fh.Rd	2015-06-02 19:43:07 UTC (rev 993)
+++ pkg/dplR/man/read.fh.Rd	2015-06-03 09:24:56 UTC (rev 994)
@@ -19,10 +19,11 @@
   Chronologies or half-chronos in fh-format are not supported.
 }
 \value{
-  A \code{data.frame} with the series in columns and the years as rows.  The
-  keycodes are the column names and the years are the row
-  names.  Depending on metadata available in the input file, the
-  following attributes may be present in the \code{data.frame}:
+  An object of class \code{c("rwl", "data.frame")} with the series in
+  columns and the years as rows.  The keycodes are the column names and
+  the years are the row names.  Depending on metadata available in the
+  input file, the following attributes may be present in the
+  \code{data.frame}:
 
   \item{ids}{A \code{data.frame} identifying the series.  Always contains
     columns \code{"tree"} and \code{"core"}, may contain columns

Modified: pkg/dplR/man/read.rwl.Rd
===================================================================
--- pkg/dplR/man/read.rwl.Rd	2015-06-02 19:43:07 UTC (rev 993)
+++ pkg/dplR/man/read.rwl.Rd	2015-06-03 09:24:56 UTC (rev 994)
@@ -30,10 +30,11 @@
   read operation.
 }
 \value{
-  If a \code{"tucson"} or \code{"compact"} file is read (even through
-  \code{"auto"}), returns a \code{data.frame} with the series in columns
-  and the years as rows.  The series \acronym{ID}s are the column names
-  and the years are the row names.
+  If a \code{"tucson"}, \code{"compact"} or \code{"heidelberg"} file is
+  read (even through \code{"auto"}), returns an object of class
+  \code{c("rwl", "data.frame")} with the series in columns and the years
+  as rows.  The series \acronym{ID}s are the column names and the years
+  are the row names.
   
   If a \code{"tridas"} file is read (even through \code{"auto"}),
   returns a list of results.  See \code{\link{read.tridas}} for more

Modified: pkg/dplR/man/read.tucson.Rd
===================================================================
--- pkg/dplR/man/read.tucson.Rd	2015-06-02 19:43:07 UTC (rev 993)
+++ pkg/dplR/man/read.tucson.Rd	2015-06-03 09:24:56 UTC (rev 994)
@@ -40,9 +40,9 @@
   formatting problems.
 }
 \value{
-  A \code{data.frame} with the series in columns and the years as
-  rows.  The series \acronym{ID}s are the column names and the years are
-  the row names.
+  An object of class \code{c("rwl", "data.frame")} with the series in
+  columns and the years as rows.  The series \acronym{ID}s are the
+  column names and the years are the row names.
 }
 \author{ Andy Bunn.  Patched and greatly improved by Mikko Korpela. }
 \seealso{ \code{\link{read.rwl}}, \code{\link{read.compact}},

Modified: pkg/dplR/man/treeMean.Rd
===================================================================
--- pkg/dplR/man/treeMean.Rd	2015-06-02 19:43:07 UTC (rev 993)
+++ pkg/dplR/man/treeMean.Rd	2015-06-03 09:24:56 UTC (rev 994)
@@ -22,7 +22,8 @@
   Here.
 }
 \value{
-  A \code{data.frame} with the means of each tree.
+  An object of class \code{c("rwl", "data.frame")} with the means of
+  each tree.
 }
 
 \author{ Andy Bunn. Patched and improved by Mikko Korpela. }