[Rcolony-commits] r56 - pkg/man

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

Author: jonesor
Date: 2009-05-18 22:14:40 +0200 (Mon, 18 May 2009)
New Revision: 56

Modified:
   pkg/man/get.interm.data.Rd
Log:
Fixed get.interm.data formatting error (extra bracket)

Modified: pkg/man/get.interm.data.Rd
===================================================================
--- pkg/man/get.interm.data.Rd	2009-05-17 12:04:07 UTC (rev 55)
+++ pkg/man/get.interm.data.Rd	2009-05-18 20:14:40 UTC (rev 56)
@@ -3,18 +3,19 @@
 
 \title{ A function to collect intermediate data produced by Colony2 while it is running. }
 \description{
-While it is running, Colony2 produces output to indicate the computation progress. This function allows R to import the outputs produced.}
-It is intended to be called from \code{\link{monitor.colony}} rather than being used directly by the user.
+While it is running, Colony2 produces output to indicate the computation progress. This function allows R to import the outputs produced.
+It is intended to be called from the monitor.colony function rather than being used directly by the user.}
+
 \usage{
 get.interm.data(variable="CrLogL",datadir=getwd(),n=1)
 }
-%- maybe also 'usage' for other objects documented here.
+
 \arguments{
   \item{variable}{The name of the variable that you wish to monitor. See details.}
  \item{datadir}{The path to the directory that contains the Colony output files.}
 \item{n}{If there are two variables with the same name, which one should be used? See details.}
+}
 
-}
 \details{
 The intermediate results available are:
 
@@ -33,7 +34,6 @@
 \emph{IterLmt\%} : = (Number of iterates) / (Maximum number of iterates) within a temperature. Variable
 \emph{CrLogL} : The log likelihood of the current configuration. Variable
 \emph{BtLogL} : The best log likelihood reached with the current configuration. Variable
-
 \emph{#F1} : Current number of paternal sib families. Variable
 \emph{#F2} : Current number of maternal sib families. Variable
 \emph{#F3} : Current number of sib family clusters. Variable
@@ -59,4 +59,4 @@
 \seealso{\code{\link{monitor.colony}} }
 \examples{}
 
-\keyword{ datagen }
+\keyword{datagen}