[Phylobase-commits] r531 - pkg/man

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

Author: bbolker
Date: 2009-08-20 18:18:31 +0200 (Thu, 20 Aug 2009)
New Revision: 531

Modified:
   pkg/man/tip.data.plot.Rd
Log:

 doc tweaks to avoid messages at build time



Modified: pkg/man/tip.data.plot.Rd
===================================================================
--- pkg/man/tip.data.plot.Rd	2009-08-20 15:57:02 UTC (rev 530)
+++ pkg/man/tip.data.plot.Rd	2009-08-20 16:18:31 UTC (rev 531)
@@ -1,13 +1,11 @@
 \name{tip.data.plot}
 \Rdversion{1.1}
 \alias{tip.data.plot}
-%- Also NEED an '\alias' for EACH other topic documented here.
 \title{Plotting trees and associated data}
 \description{Plotting phylogenetic trees and associated data}
 \usage{
 tip.data.plot(xxyy, type = c("phylogram", "cladogram", "fan"), show.tip.label = TRUE, show.node.label = FALSE, tip.order = NULL, rot = 0, tip.plot.fun = grid.points, edge.color = "black", node.color = "black", tip.color = "black", edge.width = 1, ...)
 }
-%- maybe also 'usage' for other objects documented here.
 \arguments{
   \item{xxyy}{A list created by the  \code{\link{phyloXXYY}} function}
   \item{type}{ A character string indicating the shape of plotted tree }
@@ -20,39 +18,13 @@
   \item{node.color}{ A vector of colors indicating the colors of the node labels }
   \item{tip.color}{ A vector of colors indicating the colors of the tip labels }
   \item{edge.width}{ A vector in the order of \code{edges(phy)} indicating the widths of edge lines}
-  \item{\dots}{Additional parameters passed to tip.data.plot}
+  \item{\dots}{Additional parameters passed to \code{tip.plot.fun}}
 
 }
-\details{
-%%  ~~ If necessary, more details than the description above ~~
-}
 \value{
-%%  ~Describe the value returned
-%%  If it is a LIST, use
-%%  \item{comp1 }{Description of 'comp1'}
-%%  \item{comp2 }{Description of 'comp2'}
-%% ...
+  creates a plot on the current graphics device.
 }
-\references{
-%% ~put references to the literature/web site here ~
-}
 \author{
-%%  ~~who you are~~
+  Peter Cowan
 }
-\note{
-%%  ~~further notes~~
-}
-
-%% ~Make other sections like Warning with \section{Warning }{....} ~
-
-\seealso{
-%% ~~objects to See Also as \code{\link{help}}, ~~~
-}
-\examples{
-##---- Should be DIRECTLY executable !! ----
-##-- ==>  Define data, use random,
-##--	or do  help(data=index)  for the standard data sets.
-
-## The function is currently defined as
-}
 \keyword{methods}