[Analogue-commits] r274 - in pkg: . R inst man tests/Examples

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

Author: gsimpson
Date: 2012-07-29 11:39:31 +0200 (Sun, 29 Jul 2012)
New Revision: 274

Modified:
   pkg/DESCRIPTION
   pkg/NAMESPACE
   pkg/R/caterpillarPlot.R
   pkg/inst/ChangeLog
   pkg/man/caterpillarPlot.Rd
   pkg/tests/Examples/analogue-Ex.Rout.save
Log:
add short form for caterpillarPlot

Modified: pkg/DESCRIPTION
===================================================================
--- pkg/DESCRIPTION	2012-07-28 22:03:25 UTC (rev 273)
+++ pkg/DESCRIPTION	2012-07-29 09:39:31 UTC (rev 274)
@@ -1,7 +1,7 @@
 Package: analogue
 Type: Package
 Title: Analogue and weighted averaging methods for palaeoecology
-Version: 0.9-9
+Version: 0.9-10
 Date: $Date$
 Depends: R (>= 2.15.0), stats, graphics, vegan (>= 1.17-12), lattice, grid, 
          MASS, princurve, mgcv

Modified: pkg/NAMESPACE
===================================================================
--- pkg/NAMESPACE	2012-07-28 22:03:25 UTC (rev 273)
+++ pkg/NAMESPACE	2012-07-29 09:39:31 UTC (rev 274)
@@ -20,6 +20,7 @@
 export(analog,
        bayesF,
        bootstrap,
+       caterpillar,
        caterpillarPlot,
        chooseTaxa,
        cma,

Modified: pkg/R/caterpillarPlot.R
===================================================================
--- pkg/R/caterpillarPlot.R	2012-07-28 22:03:25 UTC (rev 273)
+++ pkg/R/caterpillarPlot.R	2012-07-29 09:39:31 UTC (rev 274)
@@ -1,3 +1,7 @@
+`caterpillar` <- function(x, ...) {
+    UseMethod("caterpillarPlot")
+}
+
 `caterpillarPlot` <- function(x, ...) {
     UseMethod("caterpillarPlot")
 }

Modified: pkg/inst/ChangeLog
===================================================================
--- pkg/inst/ChangeLog	2012-07-28 22:03:25 UTC (rev 273)
+++ pkg/inst/ChangeLog	2012-07-29 09:39:31 UTC (rev 274)
@@ -1,5 +1,10 @@
 analogue Change Log
 
+Version 0.9-10
+
+	* caterpillarPlot: can now be called by the shorter name
+	caterpillar().
+
 Version 0.9-9
 
 	* prcurve: added a print method.

Modified: pkg/man/caterpillarPlot.Rd
===================================================================
--- pkg/man/caterpillarPlot.Rd	2012-07-28 22:03:25 UTC (rev 273)
+++ pkg/man/caterpillarPlot.Rd	2012-07-29 09:39:31 UTC (rev 274)
@@ -3,6 +3,7 @@
 \alias{caterpillarPlot.default}
 \alias{caterpillarPlot.data.frame}
 \alias{caterpillarPlot.wa}
+\alias{caterpillar}
 
 \title{
   Caterpillar plot of species' WA optima and tolerance range.
@@ -14,7 +15,6 @@
 }
 
 \usage{
-
 \method{caterpillarPlot}{default}(x, tol, mult = 1, decreasing = TRUE,
                 labels, xlab = NULL, pch = 21, bg = "white",
                 col = "black", lcol = col, lwd = 2, frame.plot = FALSE, ...)
@@ -54,9 +54,13 @@
     plotting functions.}
 }
 
-%\details{
-%%  ~~ If necessary, more details than the description above ~~
-%}
+\details{
+  The function may also be called using the short form name
+  \code{caterpillar}:
+  \preformatted{
+caterpillar(x, ...)
+  }
+}
 
 \value{
   The function results in a plot on the currently active device. A data
@@ -86,12 +90,16 @@
 
 ## customisation
 opttol <-
-    caterpillarPlot(ImbrieKipp, SumSST, col = "red2", bg = "yellow",
-                    lcol = "blue",
-                    xlab = expression(Summer~Sea~Surface~Temperature~(degree*C)))
+    caterpillarPlot(ImbrieKipp, SumSST, col = "red2",
+                    bg = "yellow", lcol = "blue",
+                    xlab = expression(Summer ~ Sea ~ Surface ~
+                                      Temperature~(degree*C)))
 
 ## invisibly returns the optima and tolerances
 head(opttol)
+
+## The short form name may be easier on the typing fingers
+caterpillar(ImbrieKipp, SumSST)
 }
 
 % Add one or more standard keywords, see file 'KEYWORDS' in the

Modified: pkg/tests/Examples/analogue-Ex.Rout.save
===================================================================
--- pkg/tests/Examples/analogue-Ex.Rout.save	2012-07-28 22:03:25 UTC (rev 273)
+++ pkg/tests/Examples/analogue-Ex.Rout.save	2012-07-29 09:39:31 UTC (rev 274)
@@ -31,7 +31,7 @@
 Loading required package: princurve
 Loading required package: mgcv
 This is mgcv 1.7-19. For overview type 'help("mgcv-package")'.
-This is analogue 0.9-9
+This is analogue 0.9-10
 > 
 > assign(".oldSearch", search(), pos = 'CheckExEnv')
 > cleanEx()
@@ -1186,7 +1186,7 @@
 > ### Name: caterpillarPlot
 > ### Title: Caterpillar plot of species' WA optima and tolerance range.
 > ### Aliases: caterpillarPlot caterpillarPlot.default
-> ###   caterpillarPlot.data.frame caterpillarPlot.wa
+> ###   caterpillarPlot.data.frame caterpillarPlot.wa caterpillar
 > ### Keywords: hplot
 > 
 > ### ** Examples
@@ -1199,9 +1199,10 @@
 > 
 > ## customisation
 > opttol <-
-+     caterpillarPlot(ImbrieKipp, SumSST, col = "red2", bg = "yellow",
-+                     lcol = "blue",
-+                     xlab = expression(Summer~Sea~Surface~Temperature~(degree*C)))
++     caterpillarPlot(ImbrieKipp, SumSST, col = "red2",
++                     bg = "yellow", lcol = "blue",
++                     xlab = expression(Summer ~ Sea ~ Surface ~
++                                       Temperature~(degree*C)))
 > 
 > ## invisibly returns the optima and tolerances
 > head(opttol)
@@ -1213,8 +1214,11 @@
 G.saccu 26.18001  1.979651
 G.mentu 26.13778  2.386584
 > 
+> ## The short form name may be easier on the typing fingers
+> caterpillar(ImbrieKipp, SumSST)
 > 
 > 
+> 
 > cleanEx()
 > nameEx("chooseTaxa")
 > ### * chooseTaxa
@@ -7246,7 +7250,7 @@
 > ### * <FOOTER>
 > ###
 > cat("Time elapsed: ", proc.time() - get("ptime", pos = 'CheckExEnv'),"\n")
-Time elapsed:  19.235 0.232 19.942 0 0 
+Time elapsed:  19.233 0.237 20.124 0 0 
 > grDevices::dev.off()
 null device 
           1