1. crlmm
  2. man
  3. posteriorProbability.Rd
Browse code

Do not export calculatePosteriorMean

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

Rob Scharp authored on 11/10/2011 12:17:35
Showing1 changed files
man/posteriorProbability.Rd
History View file @3b0b210
... ... 
@@ -30,9 +30,11 @@ posteriorProbability(object, predictRegion, copyNumber = 0:4, w)
30 30 
     to 1.}
31 31
32 32 
 }
33 
-\details{
34 33
34 
+\details{
35 
+This is currently under development.
35 36 
 }
37 
+
36 38 
 \value{
37 39 
 An array (features x samples x copy number)
38 40 
 }
... ... 
@@ -40,25 +42,26 @@ An array (features x samples x copy number)
40 42 
 \author{
41 43 
 R. Scharpf
42 44 
 }
45 
+
43 46 
 \note{
44 
-  %Remark about nonpolymorphic probes
47 
+  This is under development. Use at your own risk.
45 48 
 }
46 49
47 50 
 %% ~Make other sections like Warning with \section{Warning }{....} ~
48 51
49 52 
 \seealso{
50 
-  \code{\link{predictionRegion}}, \code{\link{genotypes}}, \code{\link{calculatePosteriorMean}}
53 
+  \code{\link{predictionRegion}}, \code{\link{genotypes}} %\code{\link{calculatePosteriorMean}}
51 54 
 }
52 55 
 \examples{
53 
-data(sample.CNSet)
54 
-pr <- predictionRegion(sample.CNSet, copyNumber=0:4)
55 
-pp <- posteriorProbability(sample.CNSet, predictRegion=pr)
56 
+data(cnSetExample)
57 
+pr <- predictionRegion(cnSetExample, copyNumber=0:4)
58 
+pp <- posteriorProbability(cnSetExample, predictRegion=pr)
56 59 
 dim(pp)
57 60
58 61 
 ## multiple batches
59 
-data(sample.CNSet2)
60 
-pr <- predictionRegion(sample.CNSet2, copyNumber=0:4)
61 
-pp <- posteriorProbability(sample.CNSet2, predictRegion=pr)
62 
+data(cnSetExample2)
63 
+pr <- predictionRegion(cnSetExample2, copyNumber=0:4)
64 
+pp <- posteriorProbability(cnSetExample2, predictRegion=pr)
62 65 
 }
63 66 
 % Add one or more standard keywords, see file 'KEYWORDS' in the
64 67 
 % R documentation directory.
Browse code

Simplify accessors for batch summaries: Ns, corr, medians, mads

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

Rob Scharp authored on 01/10/2011 04:48:38
Showing1 changed files
man/posteriorProbability.Rd
History View file @6dc7b94
... ... 
@@ -27,7 +27,7 @@ posteriorProbability(object, predictRegion, copyNumber = 0:4, w)
27 27
28 28 
   \item{w}{ numeric vector of prior probabilities for each of the copy
29 29 
     number states.  Must be the same length as \code{copyNumber} and sum
30 
-    to 1.
30 
+    to 1.}
31 31
32 32 
 }
33 33 
 \details{
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
Showing1 changed files
man/posteriorProbability.Rd
History View file @1821feb
... ... 
@@ -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
Browse code

Update help files for posteriorProbability and calculatePosteriorMean

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

Rob Scharp authored on 01/10/2011 04:47:53
Showing1 changed files
man/posteriorProbability.Rd
History View file @8e21c72
... ... 
@@ -49,6 +49,11 @@ data(sample.CNSet)
49 49 
 pr <- predictionRegion(sample.CNSet, copyNumber=0:4)
50 50 
 pp <- posteriorProbability(sample.CNSet, predictRegion=pr)
51 51 
 dim(pp)
52 
+
53 
+## multiple batches
54 
+data(sample.CNSet2)
55 
+pr <- predictionRegion(sample.CNSet2, copyNumber=0:4)
56 
+pp <- posteriorProbability(sample.CNSet2, predictRegion=pr)
52 57 
 }
53 58 
 % Add one or more standard keywords, see file 'KEYWORDS' in the
54 59 
 % R documentation directory.
Browse code

Add examples for calculatePosteriorMean and posteriorProbability help files

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

Rob Scharp authored on 01/10/2011 04:47:17
Showing1 changed files
man/posteriorProbability.Rd
History View file @aaef0d8
... ... 
@@ -45,6 +45,10 @@ R. Scharpf
45 45 
   \code{\link{predictionRegion}}, \code{\link{genotypes}}, \code{\link{calculatePosteriorMean}}
46 46 
 }
47 47 
 \examples{
48 
+data(sample.CNSet)
49 
+pr <- predictionRegion(sample.CNSet, copyNumber=0:4)
50 
+pp <- posteriorProbability(sample.CNSet, predictRegion=pr)
51 
+dim(pp)
48 52 
 }
49 53 
 % Add one or more standard keywords, see file 'KEYWORDS' in the
50 54 
 % R documentation directory.
Browse code

Add Rd files for calculatePosteriorMean, genotypes, posteriorProbability, and predictionRegion

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

Rob Scharp authored on 01/10/2011 04:46:59
Showing1 changed files
man/posteriorProbability.Rd
History View file @4d74818
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,51 @@
1 
+\name{posteriorProbability}
2 
+\alias{posteriorProbability}
3 
+\alias{posteriorProbability,CNSet-method}
4 
+%- Also NEED an '\alias' for EACH other topic documented here.
5 
+\title{Calculate the posterior probability for integer copy numbers.}
6 
+
7 
+\description{
8 
+  Calculate the posterior probability for integer copy numbers using the
9 
+  bivariate normal prediction regions.
10 
+}
11 
+
12 
+\usage{
13 
+posteriorProbability(object, predictRegion, copyNumber = 0:4)
14 
+}
15 
+%- maybe also 'usage' for other objects documented here.
16 
+\arguments{
17 
+  \item{object}{
18 
+    A \code{CNSet} object.
19 
+}
20 
+  \item{predictRegion}{
21 
+    A list containing the bivariate normal prediction region for each of
22 
+    the possible genotypes.
23 
+}
24 
+  \item{copyNumber}{
25 
+    Integer vector.
26 
+}
27 
+}
28 
+\details{
29 
+
30 
+}
31 
+\value{
32 
+An array (features x samples x copy number)
33 
+}
34 
+
35 
+\author{
36 
+R. Scharpf
37 
+}
38 
+\note{
39 
+  %Remark about nonpolymorphic probes
40 
+}
41 
+
42 
+%% ~Make other sections like Warning with \section{Warning }{....} ~
43 
+
44 
+\seealso{
45 
+  \code{\link{predictionRegion}}, \code{\link{genotypes}}, \code{\link{calculatePosteriorMean}}
46 
+}
47 
+\examples{
48 
+}
49 
+% Add one or more standard keywords, see file 'KEYWORDS' in the
50 
+% R documentation directory.
51 
+\keyword{array}
0 52 
\ No newline at end of file