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

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

Author: mvkorpel
Date: 2018-11-03 21:22:34 +0100 (Sat, 03 Nov 2018)
New Revision: 1130

Modified:
   pkg/dplR/man/detrend.Rd
   pkg/dplR/man/detrend.series.Rd
   pkg/dplR/man/plotRings.Rd
Log:
Cosmetic changes to docs, mainly shortened lines


Modified: pkg/dplR/man/detrend.Rd
===================================================================
--- pkg/dplR/man/detrend.Rd	2018-11-03 19:27:41 UTC (rev 1129)
+++ pkg/dplR/man/detrend.Rd	2018-11-03 20:22:34 UTC (rev 1130)
@@ -8,7 +8,8 @@
 }
 \usage{
 detrend(rwl, y.name = names(rwl), make.plot = FALSE,
-        method = c("Spline", "ModNegExp", "Mean", "Ar", "Friedman", "ModHugershoff"),
+        method = c("Spline", "ModNegExp", "Mean", "Ar", "Friedman",
+                   "ModHugershoff"),
         nyrs = NULL, f = 0.5, pos.slope = FALSE,
         constrain.nls = c("never", "when.fail", "always"),
         verbose = FALSE, return.info = FALSE,
@@ -27,8 +28,8 @@
     and detrended data if \code{TRUE}.  See details below. }
   
   \item{method}{ a \code{character} vector to determine the detrending
-    methods.  See details below.  Possible values are all subsets of
-    \code{c("Spline", "ModNegExp", "Mean", "Ar", "Friedman", "ModHugershoff")}.  
+    methods.  See details below.  Possible values are all subsets of\cr
+    \code{c("Spline", "ModNegExp", "Mean", "Ar", "Friedman", "ModHugershoff")}.
     Defaults to using all the available methods.}
   
   \item{nyrs}{ a number giving the rigidity of the smoothing spline,
@@ -111,13 +112,16 @@
 data(ca533)
 ## Detrend using modified exponential decay. Returns a data.frame
 ca533.rwi <- detrend(rwl = ca533, method = "ModNegExp")
-## Detrend using a slines on power transformed data and compute residuals via subtraction
-ca533.rwi <- detrend(rwl = powt(ca533), method = "Spline", difference = TRUE)
+## Detrend using a slines on power transformed data and compute
+## residuals via subtraction
+ca533.rwi <- detrend(rwl = powt(ca533), method = "Spline",
+                     difference = TRUE)
 
-## Detrend using modified Hugershoff curve and return info on the model fits.
-## Returns a list with: series, curves, modelinfo and data.info
+## Detrend using modified Hugershoff curve and return info on the model
+## fits. Returns a list with: series, curves, modelinfo and data.info
 data(co021)
-co021.rwi <- detrend(rwl = co021, method = "ModHugershoff", return.info=TRUE)
+co021.rwi <- detrend(rwl = co021, method = "ModHugershoff",
+                     return.info=TRUE)
 
 \dontrun{
 library(grDevices)

Modified: pkg/dplR/man/detrend.series.Rd
===================================================================
--- pkg/dplR/man/detrend.series.Rd	2018-11-03 19:27:41 UTC (rev 1129)
+++ pkg/dplR/man/detrend.series.Rd	2018-11-03 20:22:34 UTC (rev 1130)
@@ -26,9 +26,9 @@
     and detrended data if \code{TRUE}. }
 
   \item{method}{ a \code{character} vector to determine the detrending
-    methods.  See details below.  Possible values are all subsets of
-    \code{c("Spline", "ModNegExp", "Mean", "Ar", "Friedman")}.  Defa
-    ults to using all the available methods.}
+    methods.  See details below.  Possible values are all subsets of\cr
+    \code{c("Spline", "ModNegExp", "Mean", "Ar", "Friedman", "ModHugershoff")}.
+    Defaults to using all the available methods.}
 
   \item{nyrs}{ a number controlling the smoothness of the
     fitted curve in method \code{"Spline"},

Modified: pkg/dplR/man/plotRings.Rd
===================================================================
--- pkg/dplR/man/plotRings.Rd	2018-11-03 19:27:41 UTC (rev 1129)
+++ pkg/dplR/man/plotRings.Rd	2018-11-03 20:22:34 UTC (rev 1130)
@@ -85,7 +85,7 @@
 
 This makes a plot, drawing all rings from tree-ring series on a Cartesian plane of up to four cardinal directions (N, S, E, W) defining the eccentricity of the stem. It can be plotted using only data from one ratio, or up to four different radii from same tree. This function can plot each individual ring as an animation within the R-GUI, as a \acronym{GIF}-file, or it can plot all rings at once.
 
-Animations require a functional installation of ImageMagick [https://www.imagemagick.org] where the ImageMagick program \code{convert} is configured correctly in the \code{PATH}. At the moment, the \code{saveGIF} option in \code{plotRings} is stable but occassionaly fails. Should users encoutner issues saving a \acronym{GIF}, the problem might be related  to the installation of ImageMagick the details of which depend on platform. See \code{\link{saveGIF}} for details.
+Animations require a functional installation of ImageMagick [\url{https://www.imagemagick.org}] where the ImageMagick program \code{convert} is configured correctly in the \code{PATH}. At the moment, the \code{saveGIF} option in \code{plotRings} is stable but occassionaly fails. Should users encoutner issues saving a \acronym{GIF}, the problem might be related  to the installation of ImageMagick the details of which depend on platform. See \code{\link{saveGIF}} for details.
 
 }
 \value{
@@ -122,8 +122,10 @@
                  col.inrings = terrain.colors(nrow(anos1))) 
 
 #Setting the length.unit
-res <- plotRings(yrs,  anos1[,4], trwW = anos1[,5],sp="Cedrela odorata", length.unit = "mm")
-res <- plotRings(yrs,  anos1[,4], trwW = anos1[,5],sp="Cedrela odorata", length.unit = "1/100 mm")
+res <- plotRings(yrs,  anos1[,4], trwW = anos1[,5],sp="Cedrela odorata",
+                 length.unit = "mm")
+res <- plotRings(yrs,  anos1[,4], trwW = anos1[,5],sp="Cedrela odorata",
+                 length.unit = "1/100 mm")
 
 # Specifying x.rings highlighting only narrow rings
 res <- plotRings(yrs, anos1[,4], trwW = anos1[,5],