[Vegan-commits] r1712 - in pkg/lmodel2: . man

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

Author: jarioksa
Date: 2011-08-13 08:55:36 +0200 (Sat, 13 Aug 2011)
New Revision: 1712

Modified:
   pkg/lmodel2/NAMESPACE
   pkg/lmodel2/man/lmodel2.Rd
Log:
more visibility to helper functions

Modified: pkg/lmodel2/NAMESPACE
===================================================================
--- pkg/lmodel2/NAMESPACE	2011-08-11 07:58:19 UTC (rev 1711)
+++ pkg/lmodel2/NAMESPACE	2011-08-13 06:55:36 UTC (rev 1712)
@@ -1,4 +1,8 @@
+## The main function
 export(lmodel2)
+## Make visible
+export(plot.lmodel2, lines.lmodel2)
+## import for S3
 importFrom(graphics, plot, lines)
 ## S3 methods
 S3method(print, lmodel2)

Modified: pkg/lmodel2/man/lmodel2.Rd
===================================================================
--- pkg/lmodel2/man/lmodel2.Rd	2011-08-11 07:58:19 UTC (rev 1711)
+++ pkg/lmodel2/man/lmodel2.Rd	2011-08-13 06:55:36 UTC (rev 1712)
@@ -3,7 +3,12 @@
 \alias{lmodel2}
 \alias{plot.lmodel2}
 \alias{lines.lmodel2}
+\alias{print.lmodel2}
 \alias{permutest.lmodel2}
+\alias{MA.reg}
+\alias{SMA.reg}
+\alias{CLma}
+\alias{CLsma}
 
 \title{Model II regression}
 
@@ -109,6 +114,15 @@
 \code{vignette("mod2user", package="lmodel2")}. 
 }
 
+\note{The package exports only the main functions \code{lmodel2},
+  \code{plot.lmodel2} and \code{lines.lmodel2}.  Much of the work is
+  done by private functions which are not directly visible to the
+  user, but you must use triple colon to see or directly use these
+  functions (e.g., \code{lmodel2:::print.lmodel2}).  Internal functions
+  that perform essential parts of the analysis are \code{MA.reg},
+  \code{SMA.reg}, \code{CLma}, \code{CLsma} and
+  \code{permutest.lmodel2}. }
+
 \author{ Pierre Legendre, Departement de Sciences Biologiques, Universite de Montreal }
 
 \examples{