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

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

Author: andybunn
Date: 2014-01-14 19:05:30 +0100 (Tue, 14 Jan 2014)
New Revision: 725

Modified:
   pkg/dplR/R/detrend.series.R
   pkg/dplR/man/detrend.series.Rd
Log:
Small wording changes made to warning message on constrain.modnegexp and in help file of detrend.series().

Modified: pkg/dplR/R/detrend.series.R
===================================================================
--- pkg/dplR/R/detrend.series.R	2014-01-14 16:12:32 UTC (rev 724)
+++ pkg/dplR/R/detrend.series.R	2014-01-14 18:05:30 UTC (rev 725)
@@ -80,7 +80,7 @@
         if (mneNotPositive || class(ModNegExp) == "try-error") {
             ## Straight line via linear regression
             if (mneNotPositive) {
-                warning("ModNegExp fit is not all positive, see constrain.modnegexp")
+                warning("Fits from ModNegExp are not all positive, see constrain.modnegexp argument in detrend.series")
             }
             tm <- cbind(1, seq_len(nY2))
             lm1 <- lm.fit(tm, y2)

Modified: pkg/dplR/man/detrend.series.Rd
===================================================================
--- pkg/dplR/man/detrend.series.Rd	2014-01-14 16:12:32 UTC (rev 724)
+++ pkg/dplR/man/detrend.series.Rd	2014-01-14 18:05:30 UTC (rev 725)
@@ -93,9 +93,13 @@
   ring-width indices.
 
   These methods are chosen because they are commonly used in
-  dendrochronology.  It is, of course, up to the user to determine the
-  best detrending method for their data. See the references below for
-  further details on detrending.
+  dendrochronology. There is a rich literature on detrending
+  and many researchers are particularly skeptical of the use of the 
+  classic nonlinear model of biological growth (\eqn{f(t) = a e^{b t} + k}{f(t)
+  = a exp(b t) + k}) for detrending. It is, of course, up to the 
+  user to determine the best detrending method for their data. 
+  
+  See the references below for further details on detrending. 
 }
 \value{
   If several methods are used, returns a \code{data.frame} containing