[Ecopd-commits] r77 - branches/single-tree/man

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

Author: regetz
Date: 2009-11-18 01:06:25 +0100 (Wed, 18 Nov 2009)
New Revision: 77

Added:
   branches/single-tree/man/simpson.Rd
Log:
added skeleton documentation for simpson methods


Added: branches/single-tree/man/simpson.Rd
===================================================================
--- branches/single-tree/man/simpson.Rd	                        (rev 0)
+++ branches/single-tree/man/simpson.Rd	2009-11-18 00:06:25 UTC (rev 77)
@@ -0,0 +1,36 @@
+\name{simpson}
+\docType{methods}
+\alias{simpson}
+\alias{simpson-methods}
+\alias{simpson,phylo4com-method}
+\alias{simpson,phylo4d-method}
+\title{Phylogenetic Simpson's diversity index}
+\description{
+  Calculates Simpson's diversity index for a set of communities,
+  possibly in a way that incorporates phylogenetic information
+}
+\usage{
+  \S4method{simpson}{phylo4com}(x, method = c("phylogenetic",
+    "traditional"))
+  \S4method{simpson}{phylo4d}(x, method = c("phylogenetic",
+    "traditional"))
+}
+\arguments{
+  \item{x}{A \code{phylo4com} or \code{phylo4d} object.}
+  \item{method}{character indicating whether to compute the
+    \dQuote{phylogenetic} or \dQuote{traditional} Simpson's index}
+}
+\details{
+  TODO
+}
+\value{
+  A numeric vector of length equal to the number of communities.
+}
+\references{
+  TODO
+}
+\author{Jim Regetz (regetz at nceas.ucsb.edu)}
+\examples{
+  simpson(weeds)
+}
+\keyword{methods}


Property changes on: branches/single-tree/man/simpson.Rd
___________________________________________________________________
Name: svn:eol-style
   + native