[Vegan-commits] r1746 - in pkg/vegan: R inst man

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

Author: jarioksa
Date: 2011-08-23 17:50:30 +0200 (Tue, 23 Aug 2011)
New Revision: 1746

Modified:
   pkg/vegan/R/vegandocs.R
   pkg/vegan/inst/ChangeLog
   pkg/vegan/man/vegandocs.Rd
Log:
vegandocs(permutations) shows the vignette in 'permute'

Modified: pkg/vegan/R/vegandocs.R
===================================================================
--- pkg/vegan/R/vegandocs.R	2011-08-23 14:40:27 UTC (rev 1745)
+++ pkg/vegan/R/vegandocs.R	2011-08-23 15:50:30 UTC (rev 1746)
@@ -1,11 +1,14 @@
 `vegandocs` <-
     function (doc = c("NEWS", "ChangeLog", "FAQ-vegan.pdf", "intro-vegan.pdf",
               "diversity-vegan.pdf", "decision-vegan.pdf",
-              "partitioning.pdf")) 
+              "partitioning.pdf", "permutations.pdf")) 
 {
     doc <- match.arg(doc)
     if (length(grep(".pdf", doc)) > 0) {
-        doc <- file.path(system.file(package="vegan"), "doc", doc)
+        if (doc == "permutations.pdf")
+            doc <- file.path(system.file(package="permute"), "doc", doc)
+        else
+            doc <- file.path(system.file(package="vegan"), "doc", doc)
         if (.Platform$OS.type == "windows")
             shell.exec(doc)
         else system(paste(getOption("pdfviewer"), doc, "&"))

Modified: pkg/vegan/inst/ChangeLog
===================================================================
--- pkg/vegan/inst/ChangeLog	2011-08-23 14:40:27 UTC (rev 1745)
+++ pkg/vegan/inst/ChangeLog	2011-08-23 15:50:30 UTC (rev 1746)
@@ -6,6 +6,9 @@
 
 	* NAMESPACE: imports nobs from permute_0.5-3 in R 2.12.2 and older
 	which do not yet have nobs() generic.
+
+	* vegandocs: shows the permutation vignette of the 'permute'
+	package. 
 	
 Version 1.92-0 (closed August 23, 2011)
 

Modified: pkg/vegan/man/vegandocs.Rd
===================================================================
--- pkg/vegan/man/vegandocs.Rd	2011-08-23 14:40:27 UTC (rev 1745)
+++ pkg/vegan/man/vegandocs.Rd	2011-08-23 15:50:30 UTC (rev 1746)
@@ -2,25 +2,27 @@
 \alias{vegandocs}
 
 \title{Display Package Documentation}
-\description{
-  Display package documentation using \code{pager} or \code{pdfviewer}
-  defined in \code{\link{options}}.
-}
+
+\description{ Display NEWS, vignettes, other special documents or
+  ChangeLog in \pkg{vegan}, or vignettes in \pkg{permute}. }
+
 \usage{
 vegandocs(doc = c("NEWS", "ChangeLog", "FAQ-vegan.pdf",
     "intro-vegan.pdf", "diversity-vegan.pdf", "decision-vegan.pdf",
-    "partitioning.pdf"))
+    "partitioning.pdf", "permutations.pdf"))
 }
 
 \arguments{
   \item{doc}{The name of the document (partial match, case sensitive). }
 }
 \author{Jari Oksanen }
-\note{
-  The function is a kluge, since \R does not have this facility (I hope
-  it will come there). Function \code{\link{vignette}} only works with
-  vignettes. 
-}
+
+\note{ The function is a kluge, since \R does not have this facility
+  (I hope it will come there). Function \code{\link{vignette}} only
+  works with vignettes processed by \R, but the current function also
+  shows other \code{pdf} documents. The \code{permutations.pdf}
+  document is in the \pkg{permute} package.  }
+
 \seealso{\code{\link{vignette}}. }
 \examples{
 \dontrun{