[Vegan-commits] r1397 - in branches/1.17: inst man

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

Author: jarioksa
Date: 2010-12-08 21:30:38 +0100 (Wed, 08 Dec 2010)
New Revision: 1397

Modified:
   branches/1.17/inst/ChangeLog
   branches/1.17/man/ordilabel.Rd
Log:
merge r1312,3 doc changes for ordilabel text colour (ordilabel.R merged earlier)

Modified: branches/1.17/inst/ChangeLog
===================================================================
--- branches/1.17/inst/ChangeLog	2010-12-08 19:10:34 UTC (rev 1396)
+++ branches/1.17/inst/ChangeLog	2010-12-08 20:30:38 UTC (rev 1397)
@@ -32,7 +32,7 @@
 
 	* merge r1311: plot.decorana uses points if no text available. 
 
-	* merge r1313:1314: ordilabel and ordiellipse text uses border
+	* merge r1312:1314: ordilabel and ordiellipse text uses border
 	colour. 
 
 	* merge r1315: fix swan infinite loop.

Modified: branches/1.17/man/ordilabel.Rd
===================================================================
--- branches/1.17/man/ordilabel.Rd	2010-12-08 19:10:34 UTC (rev 1396)
+++ branches/1.17/man/ordilabel.Rd	2010-12-08 20:30:38 UTC (rev 1397)
@@ -1,46 +1,53 @@
 \name{ordilabel}
 \alias{ordilabel}
 
-\title{Add Text on Non-transparent Label to an Ordination Plot }
-\description{
- Function \code{ordilabel} is similar to \code{\link{text}}, but the text is on an
- opaque label. This can help in crowded ordination plots: you still cannot see
- all text labels, but at least the uppermost are readable. Argument \code{priority}
- helps to make the most important labels visible.
-}
+\title{Add Text on Non-transparent Label to an Ordination Plot. }
+
+\description{ Function \code{ordilabel} is similar to
+  \code{\link{text}}, but the text is on an opaque label. This can help
+  in crowded ordination plots: you still cannot see all text labels, but
+  at least the uppermost are readable. Argument \code{priority} helps to
+  make the most important labels visible.  }
+
 \usage{
 ordilabel(x, display, labels, choices = c(1, 2), priority, cex = 0.8,
     fill = "white", border = NULL, col = NULL, ...)
 }
 
 \arguments{
-  \item{x}{An ordination object an any object known to \code{\link{scores}}. }
-  \item{display}{Kind of scores displayed (passed to \code{\link{scores}}). }
-  \item{labels}{Optional text used in plots. If this is not given, the text is found from the
-       ordination object.}
+  \item{x}{An ordination object an any object known to
+    \code{\link{scores}}. } 
+  \item{display}{Kind of scores displayed (passed to
+    \code{\link{scores}}). } 
+  \item{labels}{Optional text used in plots. If this is not given, the
+    text is found from the ordination object.}
   \item{choices}{Axes shown (passed to \code{\link{scores}}). }
-  \item{priority}{Vector of the same length as the number of labels. The items with
-       high priority will be plotted uppermost. }
-  \item{cex}{ Character expansion for the text (passed to \code{\link{text}}). }
-  \item{fill}{ Background colour of the labels (the \code{col} argument of
-        \code{\link{polygon}}).}
-  \item{border}{The colour and visibility of the border of the label as defined in
-         \code{\link{polygon}}).}
+  \item{priority}{Vector of the same length as the number of labels. The
+    items with high priority will be plotted uppermost. }
+  \item{cex}{ Character expansion for the text (passed to
+    \code{\link{text}}). } 
+  \item{fill}{ Background colour of the labels (the \code{col} argument
+    of \code{\link{polygon}}).}
+  \item{border}{The colour and visibility of the border of the label as
+    defined in \code{\link{polygon}}).}
   \item{col}{Text colour. Default \code{NULL} will give the value of
     \code{border} or \code{par("fg")} if \code{border} is \code{NULL}.} 
+  \item{col}{Text colour. Default \code{NULL} will give the value of
+    \code{border} or \code{par("fg")} if \code{border} is \code{NULL}.} 
   \item{\dots}{Other arguments (passed to \code{\link{text}}). }
 }
-\details{
- The function may be useful with crowded ordination plots, in particular together with
-  argument \code{priority}. You will not see all text labels, but at least some are
-  readable. Other alternatives to crowded plots are
-  \code{\link{identify.ordiplot}}, \code{\link{orditorp}} and \code{\link{orditkplot}}. 
-}
 
+\details{ The function may be useful with crowded ordination plots, in
+  particular together with argument \code{priority}. You will not see
+  all text labels, but at least some are readable. Other alternatives to
+  crowded plots are \code{\link{identify.ordiplot}},
+  \code{\link{orditorp}} and \code{\link{orditkplot}}.  }
+
 \author{ Jari Oksanen }
 
-\seealso{ \code{\link{scores}}, \code{\link{polygon}}, \code{\link{text}}. The function is
- modelled after \code{\link[ade4]{s.label}} in \pkg{ade4} package.}
+\seealso{ \code{\link{scores}}, \code{\link{polygon}},
+ \code{\link{text}}. The function is modelled after
+ \code{\link[ade4]{s.label}} in \pkg{ade4} package.} 
 \examples{
 data(dune)
 ord <- cca(dune)