[Rcolony-commits] r15 - pkg/man

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

Author: jonesor
Date: 2009-04-23 12:31:17 +0200 (Thu, 23 Apr 2009)
New Revision: 15

Modified:
   pkg/man/get.parentage.Rd
Log:
Corrected .Rd file for get.parentage function.

Modified: pkg/man/get.parentage.Rd
===================================================================
--- pkg/man/get.parentage.Rd	2009-04-23 10:26:16 UTC (rev 14)
+++ pkg/man/get.parentage.Rd	2009-04-23 10:31:17 UTC (rev 15)
@@ -1,38 +1,39 @@
 \name{get.parentage}
 \alias{get.parentage}
-%- Also NEED an '\alias' for EACH other topic documented here.
-\title{ A funciton to extract the paternity and maternity information from the colony object created with get.colony.data(). }
+
+\title{ A function to extract the paternity and maternity information from the colony object created with \code{\link{get.colony.data}}. }
 \description{
-  ~~ A concise (1-5 lines) description of what the function does. ~~
+
+This function extracts the paternity and maternity information from a colony object that was created using \code{\link{get.colony.data}}.
+The output is a dataframe with 3 columns. (1) mums, (2) dads, (3) frequency.
+The output can either be derived from pairwise-likelihood or the full-likelihood method (if available).
+
 }
 \usage{
 get.parentage(colony.object, pairwise = FALSE)
 }
 %- maybe also 'usage' for other objects documented here.
 \arguments{
-  \item{colony.object}{A list created by \code{get.colony.data}.}
+  \item{colony.object}{A list created by \code{\link{get.colony.data}}}.}
   \item{pairwise}{TRUE/FALSE: should the parentage information be derived from the pairwise likelihood estimates (TRUE), of from the full likelihood methods (FALSE). See Wang et al. for details.}
 }
-\details{
-  ~~ If necessary, more details than the description above ~~
-}
+\details{}
 \value{
   A data frame with 3 columns. (1) mums, (2) dads, (3) frequency. 
 }
-\references{ Wang }
+\references{}
 \author{Owen R. Jones}
-\note{ 
+\note{}
 
-}
-
 \seealso{ \code{\link{get.colony.data}} }
 
 \examples{
 
 data(testdata)
 parents<-get.parentage(testdata)
+head(parents)
+}
 
-
 % Add one or more standard keywords, see file 'KEYWORDS' in the
 % R documentation directory.
-\keyword{ manip }
+\keyword{manip}