[Vegan-commits] r947 - pkg/vegan/man

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

Author: jarioksa
Date: 2009-08-25 07:21:10 +0200 (Tue, 25 Aug 2009)
New Revision: 947

Modified:
   pkg/vegan/man/indpower.Rd
Log:
indpower uses \eqn instead of \code + some proof reading

Modified: pkg/vegan/man/indpower.Rd
===================================================================
--- pkg/vegan/man/indpower.Rd	2009-08-25 05:09:26 UTC (rev 946)
+++ pkg/vegan/man/indpower.Rd	2009-08-25 05:21:10 UTC (rev 947)
@@ -5,7 +5,7 @@
 \title{Indicator Power of Species}
 
 \description{ Indicator power calculation of Halme et al.  (2009)
-  scales up the congruence between indicator and target species.  
+  or the congruence between indicator and target species.  
 }
 
 \usage{
@@ -19,19 +19,19 @@
 \details{
 
   Halme et al. (2009) described an index of indicator power defined as
-  \code{IP_I = sqrt(a * b)}, where \code{a = S / O_I} and
-  \code{a = 1 - (O_T - S) / (N - O_I)}. \code{N} is the number of sites,
-  \code{S} is the number of shared occurrences of the indicator (\code{I})
-  and the target (\code{T}) species. \code{O_I} and \code{O_T} are number
+  \eqn{IP_I = \sqrt{a \times  b}}{IP_I = sqrt(a*b)}, where \eqn{a = S / O_I} and
+  \eqn{b = 1 - (O_T - S) / (N - O_I)}. 
+  \eqn{N} is the number of sites,
+  \eqn{S} is the number of shared occurrences of the indicator (\eqn{I})
+  and the target (\eqn{T}) species. \eqn{O_I} and \eqn{O_T} are number
   of occurrences of the indicator and target species. The \code{type}
   argument in the function call enables to choose which statistic to
-  return. \code{type = 0} returns \code{IP_I}, \code{type = 1} returns 
-  \code{a}, \code{type = 2} returns \code{b}.
+  return. \code{type = 0} returns \eqn{IP_I}, \code{type = 1} returns 
+  \eqn{a}, \code{type = 2} returns \eqn{b}.
   Total indicator power (TIP) of an indicator species is the column mean
   (without its own value, see examples).  
-  In the paper, one can find how to calculate confidence
+  Halme et al. (2009) explain how to calculate confidence
   intervals for these statistics.
-
 }
 \value{
   A matrix with indicator species as rows and