[Ecopd-commits] r82 - in branches/single-tree: R man

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

Author: regetz
Date: 2009-11-18 17:10:46 +0100 (Wed, 18 Nov 2009)
New Revision: 82

Added:
   branches/single-tree/man/communities.Rd
Modified:
   branches/single-tree/R/utilities.R
Log:
added simple documentation for communities function


Modified: branches/single-tree/R/utilities.R
===================================================================
--- branches/single-tree/R/utilities.R	2009-11-18 15:14:03 UTC (rev 81)
+++ branches/single-tree/R/utilities.R	2009-11-18 16:10:46 UTC (rev 82)
@@ -111,8 +111,8 @@
 }
 
 # community labels extractor
-communities <- function(phy) {
-  names(phy at metadata$comms)
+communities <- function(x) {
+  names(x at metadata$comms)
 }
 
 ## this works as implementation of dist.nodes for phylo4 objects, albeit

Added: branches/single-tree/man/communities.Rd
===================================================================
--- branches/single-tree/man/communities.Rd	                        (rev 0)
+++ branches/single-tree/man/communities.Rd	2009-11-18 16:10:46 UTC (rev 82)
@@ -0,0 +1,19 @@
+\name{communities}
+\alias{communities}
+\title{List communities}
+\description{
+  Returns the community labels associated with a phylo4com object.
+}
+\usage{
+  communities(x)
+}
+\arguments{
+  \item{x}{a phylo4com object}
+}
+\value{
+  Vector of community labels.
+}
+\author{Jim Regetz (regetz at nceas.ucsb.edu)}
+\examples{
+  communities(weeds)
+}


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