[Dplr-commits] r1014 - pkg/dplR/man

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

Author: andybunn
Date: 2016-03-04 18:26:10 +0100 (Fri, 04 Mar 2016)
New Revision: 1014

Modified:
   pkg/dplR/man/detrend.series.Rd
Log:
clarifying help fo detrend.series

Modified: pkg/dplR/man/detrend.series.Rd
===================================================================
--- pkg/dplR/man/detrend.series.Rd	2016-03-02 16:58:02 UTC (rev 1013)
+++ pkg/dplR/man/detrend.series.Rd	2016-03-04 17:26:10 UTC (rev 1014)
@@ -29,12 +29,14 @@
     \code{c("Spline", "ModNegExp", "Mean", "Ar")}.  Defaults to using all the
     available methods.}
 
-  \item{nyrs}{ a number giving the rigidity of the smoothing spline,
+  \item{nyrs}{ a number controlling the smoothness of the
+    fitted curve in method \code{"Spline"},
     defaults to 0.67 of series length if \code{\var{nyrs}} is
-    \code{NULL}. }
+    \code{NULL}. See \code{\link{ffcsaps}}.}
   
   \item{f}{ a number between 0 and 1 giving the frequency response or
-    wavelength cutoff.  Defaults to 0.5. }
+    wavelength cutoff in method \code{"Spline"}.  Defaults to 0.5. 
+    See \code{\link{ffcsaps}}.}
   
   \item{pos.slope}{ a \code{logical} flag.  Will allow for a positive
     slope to be used in method \code{"ModNegExp"}.  If \code{FALSE} the
@@ -65,7 +67,6 @@
 
   \item{bass}{ a \code{numeric} value controlling the smoothness of the
     fitted curve in method \code{"Friedman"}. See \code{\link{supsmu}}. }
-
 }
 \details{
   This detrends and standardizes a tree-ring series.  The detrending is
@@ -219,19 +220,20 @@
 data(ca533)
 series <- ca533[, "CAM011"]
 names(series) <- rownames(ca533)
-# defaults to all four methods
+# defaults to all five methods
 series.rwi <- detrend.series(y = series, y.name = "CAM011", verbose=TRUE)
 # see plot with three methods
 series.rwi <- detrend.series(y = series, y.name = "CAM011",
-                             method=c("Spline", "ModNegExp","Mean"))
+                             method=c("Spline", "ModNegExp","Friedman"))
 # see plot with two methods
 # interesting to note difference from ~200 to 250 years 
 # in terms of what happens to low frequency growth
 series.rwi <- detrend.series(y = series, y.name = "CAM011",
                              method=c("Spline", "ModNegExp"))
-# see plot with just one method
+# see plot with just one method and change the spline
+# stiffness to 50 years (which is not neccesarily a good choice!)
 series.rwi <- detrend.series(y = series, y.name = "CAM011",
-                             method="Spline")
+                             method="Spline",nyrs=50)
 # note that method "Ar" doesn't get plotted in first panel
 # since this approach doesn't approximate a growth curve.
 series.rwi <- detrend.series(y = series, y.name = "CAM011",