Browse code

computeCopynumber requires 10 or more samples

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

Rob Scharp authored on 14/07/2009 19:45:10
Showing 4 changed files

... ...
@@ -219,4 +219,8 @@ is decoded and scanned
219 219
   - copy number parameters in the featureData of the CopyNumberSet
220 220
     element are thresholded
221 221
 
222
+2009-07-14 R Scharpf - committed version 1.3.11
223
+
224
+* computeCopynumber requires 10 or more samples
225
+
222 226
 
... ...
@@ -1,7 +1,7 @@
1 1
 Package: crlmm
2 2
 Type: Package
3 3
 Title: Genotype Calling (CRLMM) and Copy Number Analysis tool for Affymetrix SNP 5.0 and 6.0 and Illumina arrays.
4
-Version: 1.3.10
4
+Version: 1.3.11
5 5
 Date: 2009-06-17
6 6
 Author: Rafael A Irizarry, Benilton S Carvalho <bcarvalh@jhsph.edu>, Robert Scharpf <rscharpf@jhsph.edu>, Matt Ritchie <mritchie@wehi.EDU.AU>
7 7
 Maintainer: Benilton S Carvalho <bcarvalh@jhsph.edu>, Robert Scharpf <rscharpf@jhsph.edu>, Matt Ritchie <mritchie@wehi.EDU.AU>
... ...
@@ -462,6 +462,9 @@ computeCopynumber <- function(object,
462 462
 			      batch,
463 463
 			      SNRmin=5,
464 464
 			      cdfName="genomewidesnp6", ...){
465
+	if(ncol(object) < 10)
466
+		stop("Must have at least 10 samples in each batch to estimate model parameters....preferably closer to 90 samples per batch")
467
+
465 468
 	##require(oligoClasses)
466 469
 	if(missing(CHR)) stop("Must specify CHR")
467 470
 	if(CHR == 24) stop("Nothing available yet for chromosome Y")
... ...
@@ -25,17 +25,19 @@ computeCopynumber(object, CHR, bias.adj=FALSE, batch, SNRmin=5, cdfName="genomew
25 25
 }
26 26
 
27 27
 \details{
28
+
29
+  This function requires 10 or more samples to estimate model
30
+  parameters.  Preferably, 70+ samples would be processed together in a
31
+  batch.
28 32
   
29
-  This function transforms the intensities to a copy number scale.  We
30
-  assume that the median within-SNP intensity across samples is 2.  We
31
-  make no assumption about the chromosomal copy number. This function is
32
-  useful for detecting rare variants (e.g., variants that would not
33
-  effect the SNP-specific quantile-based estimators of location and
34
-  scale).  When \code{bias.adj=TRUE}, an extra iteration is performed
35
-  whereby samples with a high posterior probability of having a
36
-  non-normal copy number are excluded.  The resulting within-genotype
37
-  estimators of location and scale are more robust to a large number of
38
-  samples having a copy number variant.
33
+  This function transforms the quantile-normalized fluorescence
34
+  intensities to the scale of copy number.  We assume that for any given
35
+  locus the median copy number is two for each batch. When
36
+  \code{bias.adj=TRUE}, an extra iteration is performed whereby samples
37
+  with a high posterior probability of having a non-normal copy number
38
+  are excluded.  The resulting within-genotype estimators of location
39
+  and scale are more robust to a large number of samples having a copy
40
+  number variant.
39 41
 
40 42
 }
41 43