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

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

Author: jarioksa
Date: 2010-12-12 17:23:28 +0100 (Sun, 12 Dec 2010)
New Revision: 1409

Added:
   pkg/vegan/inst/NEWS
   pkg/vegan/man/vegan-package.Rd
Modified:
   pkg/vegan/inst/ChangeLog
Log:
add vegan-package.Rd

Modified: pkg/vegan/inst/ChangeLog
===================================================================
--- pkg/vegan/inst/ChangeLog	2010-12-11 16:25:13 UTC (rev 1408)
+++ pkg/vegan/inst/ChangeLog	2010-12-12 16:23:28 UTC (rev 1409)
@@ -4,6 +4,9 @@
 
 Version 1.18-18 (opened December 1, 2010)
 
+	* vegan-package.Rd: added a package intro file (to be merged to
+	the release version 1.17-5).
+
 	* sipoo.rda: got island names, and decision-vegan.Rnw vignette was
 	changed accordingly.
 

Added: pkg/vegan/inst/NEWS
===================================================================
--- pkg/vegan/inst/NEWS	                        (rev 0)
+++ pkg/vegan/inst/NEWS	2010-12-12 16:23:28 UTC (rev 1409)
@@ -0,0 +1,3 @@
+The NEWS are only available for the release versions of vegan: 
+This is a development version. Use vegandocs("ChangeLog") to see 
+changes in the development version.

Added: pkg/vegan/man/vegan-package.Rd
===================================================================
--- pkg/vegan/man/vegan-package.Rd	                        (rev 0)
+++ pkg/vegan/man/vegan-package.Rd	2010-12-12 16:23:28 UTC (rev 1409)
@@ -0,0 +1,61 @@
+\name{vegan-package}
+\alias{vegan-package}
+\alias{vegan}
+\docType{package}
+\title{
+The Community Ecology Package
+}
+
+\description{ The \pkg{vegan} package provides tools for descriptive
+community ecology. It has most basic functions of diversity analysis,
+community ordination and dissimilarity analysis. Most of its
+multivariate tools can be used for other data types as well.  }
+
+\details{The functions in the \pkg{vegan} package contain tools for
+diversity analysis (see \code{\link{vignette}}
+\code{vegandocs("diversity")}), ordination and analysis of
+dissimilarities (see \code{\link{vignette}}
+\code{vegandocs("intro")}). Together with the \pkg{labdsv} package,
+the \pkg{vegan} package provides most standard tools of descriptive
+community analysis. Package \pkg{ade4} provides an alternative
+comprehensive package, and several other packages complement
+\pkg{vegan} and provide tools for deeper analysis in specific
+fields. Package \pkg{BiodiversityR} provides a GUI for a large subset
+of \pkg{vegan} functionality.
+
+The \pkg{vegan} package is developed at R-Forge
+(\url{http://vegan.r-forge.r-project.org}).  The R-Forge provides
+up-to-date information and mailing lists and fora for help queries and
+bug reports. Bug reports can also be emailed to the function authors
+of the package maintainers.
+
+The \pkg{vegan} documents can be read with \code{\link{vegandocs}}
+function. In addition to \code{\link{vignette}}s of basic usage, you
+can also read \code{NEWS} on the new features and bug fixes in the
+relese version (\code{vegandocs("NEWS")}), or more technical and fine
+grained history in \code{vegandocs("ChangeLog")}.  The discussion on
+design decisions can be read with \code{vegandocs("decision")}.  A
+tutorial of the package at
+\url{http://cc.oulu.fi/~jarioksa/opetus/metodi/vegantutor.pdf}
+provides a more thorough introduction to the packaage.
+
+To see the preferable citation of the package, type
+\code{citation("vegan")}.  
+}
+
+\author{ The \pkg{vegan} development team is Jari Oksanen,
+F. Guillaume Blanchet, Roeland Kindt, Pierre Legendre, R. B. O'Hara,
+Gavin L. Simpson, Peter Solymos, M. Henry H. Stevens, Helene Wagner.
+
+The maintainers at the R-Forge are Jari Oksanen <jari.oksanen at oulu.fi>
+and Gavin Simpson <gavin.simpson at ucl.ac.uk>.
+}
+
+\keyword{ package }
+\keyword{ multivariate }
+\keyword{ univar }
+\keyword{ models }
+\keyword{ spatial }
+\keyword{ nonparametric }
+\keyword{ htest }
+\keyword{ regression }
\ No newline at end of file