[Picante-commits] r51 - pkg/man

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

Author: pdc
Date: 2008-04-13 04:44:15 +0200 (Sun, 13 Apr 2008)
New Revision: 51

Modified:
   pkg/man/pic.circular.Rd
Log:
complete documentation for pic.circular()


Modified: pkg/man/pic.circular.Rd
===================================================================
--- pkg/man/pic.circular.Rd	2008-04-11 06:31:34 UTC (rev 50)
+++ pkg/man/pic.circular.Rd	2008-04-13 02:44:15 UTC (rev 51)
@@ -6,18 +6,18 @@
 \usage{
 pic.circular(x, phy, scaled = TRUE, var.contrasts = FALSE)}
 \arguments{
-  \item{x}{ ~~Describe \code{x} here~~ }
-  \item{phy}{ ~~Describe \code{phy} here~~ }
-  \item{scaled}{ ~~Describe \code{scaled} here~~ }
-  \item{var.contrasts}{ ~~Describe \code{var.contrasts} here~~ }
+  \item{x}{ A vector of class \code{circular, modulo = "2pi"} with length equal to \code{length(phy$edge.lable)}  }
+  \item{phy}{ An object of class \code{phylo} }
+  \item{scaled}{ logical, indicates whether the contrasts should be scaled with their expected variance (default to \code{TRUE}). }
+  \item{var.contrasts}{ logical, indicates whether the expected variance of the contrasts should be returned (default to \code{FALSE}) }
 }
 \details{
-  ...
+  If x has names, these are matched to the dataframe, otherwise values are expected to be in the same order and an error is issued.  
 }
 \value{
   Vector of contrasts for trait \code{x} on phylogeny \code{phy}
 }
 
-\author{ Peter Cowan <pdc at berkeley.edu> based on the ape package pic function by Emmanuel Paradis}
+\author{ Peter Cowan <pdc at berkeley.edu> based on the \code{ape} package \code{pic} function by Emmanuel Paradis}
 \keyword{univar}