Browse code

exposed combineList

git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/bsseq@70492 bc3139a8-67e5-0310-9ffc-ced21a209358

Kasper D. Hansen authored on 13/10/2012 21:33:22
Showing1 changed files

... ...
@@ -4,6 +4,7 @@
4 4
 \alias{BSseq-class}
5 5
 \alias{[,BSseq-method}
6 6
 \alias{combine,BSseq,BSseq-method}
7
+\alias{combineList}
7 8
 \alias{dim,BSseq-method}
8 9
 \alias{ncol,BSseq-method}
9 10
 \alias{nrow,BSseq-method}
... ...
@@ -137,6 +138,14 @@ of the form \code{BSseq(...)}.
137 138
 
138 139
       This function returns a logical depending on whether or not the
139 140
       \code{BSseq} object has been smoothed using \code{BSmooth}.  }
141
+
142
+    \item{\code{combineList(list)}}{
143
+
144
+      This function function is a faster way of using \code{combine} on
145
+      multiple objects, all containing methylation data for the exact same
146
+      methylation loci.  The input is a list, with each component an object
147
+      of class \code{BSseq}.  The (slower) alternative is to use
148
+      \code{Reduce(combine, list)}. }
140 149
   }
141 150
 }
142 151