[Seqinr-commits] r1562 - pkg/man

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

Author: lobry
Date: 2009-03-09 19:48:03 +0100 (Mon, 09 Mar 2009)
New Revision: 1562

Modified:
   pkg/man/peakabif.Rd
   pkg/man/plotladder.Rd
Log:
peakabif now returns more info

Modified: pkg/man/peakabif.Rd
===================================================================
--- pkg/man/peakabif.Rd	2009-03-09 18:46:28 UTC (rev 1561)
+++ pkg/man/peakabif.Rd	2009-03-09 18:48:03 UTC (rev 1562)
@@ -1,6 +1,6 @@
 \name{peakabif}
 \alias{peakabif}
-\title{Peak location extraction for ABIF data}
+\title{Extraction of Peak locations, Heights and Surfaces from ABIF data}
 \description{
   Simple peak location for data imported with the \code{\link{read.abif}} function
   using cubic spline interpolation.
@@ -40,7 +40,8 @@
   \item{...}{arguments forwarded to \code{\link{plot}}}
 }
 \value{
-  Returns invisibly the unscaled values for the location of peaks.
+  Returns invisibly a list with the unscaled values for the locations of peaks,
+  heights of peaks and surfaces of peaks.
 }
 \references{
   \code{citation("seqinr")}
@@ -56,6 +57,6 @@
 }
 \examples{
 data(JLO)
-JLO.maxis <- peakabif(JLO, 5, npeak = 14, tmin = 2.7, thres = 0.1)
+JLO.maxis <- peakabif(JLO, 5, npeak = 14, tmin = 2.7, thres = 0.1)$maxis
 }
 

Modified: pkg/man/plotladder.Rd
===================================================================
--- pkg/man/plotladder.Rd	2009-03-09 18:46:28 UTC (rev 1561)
+++ pkg/man/plotladder.Rd	2009-03-09 18:48:03 UTC (rev 1562)
@@ -39,7 +39,7 @@
   # Extract from internal size standard chanel number 5 the location 
   # of 14 peaks:
   #
-ECH.maxis <- peakabif(ECH, 5, npeak = 14, tmin = 2.7, thres = 0.1, fig = FALSE)
+ECH.maxis <- peakabif(ECH, 5, npeak = 14, tmin = 2.7, thres = 0.1, fig = FALSE)$maxis
   #
   # Load data about the expected size of peaks in bp for calibration:
   #