Browse code

Fix usage in Rd files for posterior means and posterior probabilities

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

Rob Scharp authored on 01/10/2011 04:48:31
Showing3 changed files

... ...
@@ -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.11.23
4
+Version: 1.11.24
5 5
 Date: 2010-12-10
6 6
 Author: Benilton S Carvalho <Benilton.Carvalho@cancer.org.uk>, Robert Scharpf <rscharpf@jhsph.edu>, Matt Ritchie <mritchie@wehi.edu.au>, Ingo Ruczinski <iruczins@jhsph.edu>, Rafael A Irizarry
7 7
 Maintainer: Benilton S Carvalho <Benilton.Carvalho@cancer.org.uk>, Robert Scharpf <rscharpf@jhsph.edu>, Matt Ritchie <mritchie@wehi.EDU.AU>
... ...
@@ -11,7 +11,7 @@
11 11
 }
12 12
 
13 13
 \usage{
14
-calculatePosteriorMean(object, posteriorProb, copyNumber = 0:4, w, ...)
14
+calculatePosteriorMean(object, posteriorProb, copyNumber = 0:4, ...)
15 15
 }
16 16
 %- maybe also 'usage' for other objects documented here.
17 17
 \arguments{
... ...
@@ -24,9 +24,6 @@ calculatePosteriorMean(object, posteriorProb, copyNumber = 0:4, w, ...)
24 24
 
25 25
   \item{copyNumber}{
26 26
     Integer vector.
27
-}
28
-\item{w}{
29
-  The prior probability for the copy numbers in \code{copyNumber}
30 27
 }
31 28
   \item{\dots}{
32 29
     Ignored
... ...
@@ -10,7 +10,7 @@
10 10
 }
11 11
 
12 12
 \usage{
13
-posteriorProbability(object, predictRegion, copyNumber = 0:4)
13
+posteriorProbability(object, predictRegion, copyNumber = 0:4, w)
14 14
 }
15 15
 %- maybe also 'usage' for other objects documented here.
16 16
 \arguments{
... ...
@@ -23,7 +23,12 @@ posteriorProbability(object, predictRegion, copyNumber = 0:4)
23 23
 }
24 24
   \item{copyNumber}{
25 25
     Integer vector.
26
-}
26
+  }
27
+
28
+  \item{w}{ numeric vector of prior probabilities for each of the copy
29
+    number states.  Must be the same length as \code{copyNumber} and sum
30
+    to 1.
31
+
27 32
 }
28 33
 \details{
29 34