[Rcolony-commits] r45 - pkg/man

noreply at r-forge.r-project.org noreply at r-forge.r-project.org
Fri May 8 11:11:34 CEST 2009


Author: jonesor
Date: 2009-05-08 11:11:34 +0200 (Fri, 08 May 2009)
New Revision: 45

Modified:
   pkg/man/plotsibs.Rd
Log:
Removed superfluous spaces in plotsibs.rd

Modified: pkg/man/plotsibs.Rd
===================================================================
--- pkg/man/plotsibs.Rd	2009-05-08 09:10:05 UTC (rev 44)
+++ pkg/man/plotsibs.Rd	2009-05-08 09:11:34 UTC (rev 45)
@@ -1,34 +1,25 @@
 \name{plotsibs}
 \alias{plotsibs}
-
-\title{A function to plot the sibships (full and half-sibs) in an x-y style plot.}
-
+\title{A function to plot sibships (full and half-sibs) in an x-y style plot.}
 \description{This function plots the estimated sibships from Colony data. 
 Both the x and y axis represent individuals in the population and points indicate a sibship assignment between individuals x and y.}
-
 \usage{plotsibs(colony.object, maintitle = "sibships", prob = 0.8, pairwise = FALSE)}
-
 \arguments{
   \item{colony.object}{ A list object derived from the colony data (\code{\link{get.colony.data}}).}
   \item{maintitle}{The plot's title.}
   \item{prob}{Assignment probability threshold. The probability of sibship must be greater than this value to be included in the plot.}
   \item{pairwise}{TRUE/FALSE: should pairwise sibship estimates be used. (TRUE= pairwise, FALSE=full likelihood)}
 }
-
 \details{Full sibships are shown in the upper left part of the plot, and half-sibships are shown in the lower right part. The data can be derived from pairwise methods, or from the full likelihood method.}
-
 \value{A plot showing full- or half-sibships.}
 \references{Wang, J. (2004) Sibship reconstruction from genetic data with typing errors. Genetics 166: 1963-1979.}
 \author{Owen R. Jones}
 \note{}
 \seealso{\code{\link{get.colony.data}},\code{\link{run.colony}}}
-
 \examples{
-
 data(testdata)
 
 plotsibs(testdata,maintitle="Sibships (paiwise)",pairwise=TRUE)
 plotsibs(testdata,maintitle="Sibships (full)",pairwise=FALSE)
 }
-
 \keyword{aplot}



More information about the Rcolony-commits mailing list