Browse code

Update help file for nu[A/B] and phi[A/B]

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

Rob Scharp authored on 04/10/2010 02:22:07
Showing 1 changed files

... ...
@@ -23,6 +23,10 @@ been generated by the \code{crlmmCopynumber} function.
23 23
 \usage{
24 24
 CA(object, ...)
25 25
 CB(object, ...)
26
+nuA(object)
27
+nuB(object)
28
+phiA(object)
29
+phiB(object)
26 30
 totalCopynumber(object,...)
27 31
 }
28 32
 
... ...
@@ -37,15 +41,31 @@ totalCopynumber(object,...)
37 41
 
38 42
 \details{
39 43
 
44
+	At polymorphic markers, nuA and nuB provide the intercept
45
+	coefficient (the estimated background intensity) for the A and
46
+	B alleles, respectively. phiA and phiB provide the slope
47
+	coefficients for the A and B alleles, respectively.
48
+
49
+	At nonpolymorphic markers, nuB and phiB are 'NA'.
50
+
40 51
 	These functions can be used to tranlate the normalized
41 52
 	intensities to the copy number scale.  Plotting the copy
42 53
 	number estimates as a function of physical position can be
43 54
 	used to guide downstream algorithms that smooth, as well as to
44 55
 	assess possible mosaicism.
45 56
 
57
+
46 58
 }
59
+
47 60
 \value{
48
-	A matrix of allele-specific or total copy number estimates.
61
+
62
+	nu[A/B] and phi[A/B] return matrices of the intercept and
63
+	slope coefficients, respectively.  
64
+
65
+	CA and CB return matrices of allele-specific copy number.  
66
+
67
+	totalCopynumber returns a matrix of CA+CB.
68
+
49 69
 }
50 70
 
51 71
 \seealso{