Browse code

rebuild docs

Greg Finak authored on 21/12/2020 21:09:27
Showing 2 changed files

... ...
@@ -19,6 +19,7 @@ COMPASS(
19 19
   verbose = TRUE,
20 20
   dropDegreeOne = FALSE,
21 21
   init_with_fisher = FALSE,
22
+  run_model_or_return_data = "run_model",
22 23
   ...
23 24
 )
24 25
 }
... ...
@@ -71,6 +72,8 @@ and merge them with the negative subset.}
71 72
 \item{init_with_fisher}{Boolean;initialize from fisher's exact test. Any subset and subject with lower 95% log odds estimate >1 will be initialized as a responder.
72 73
 Otherwise initialize very subject and subset as a responder except those where ps <= pu.}
73 74
 
75
+\item{run_model_or_return_data}{\code{character} defaults to \code{"run_model"} otherwise set it to \code{"return_data"} in order to not fit the model just return the data set needed for modeling. Useful for extracting the boolean counts.}
76
+
74 77
 \item{...}{Other arguments; currently unused.}
75 78
 }
76 79
 \value{
... ...
@@ -29,13 +29,11 @@ from a \code{COMPASS} fit object.
29 29
 The posterior items retrieved are described as follows::
30 30
 
31 31
 \describe{
32
-\item{\code{PosteriorPs}:}{The posterior probability that the samples
33
-subjected to the 'treatment', or 'stimulated', condition responded.}
34
-\item{\code{PosteriorPu:}}{The posterior probability that the samples
35
-subjected to the 'control', or 'unstimulated', condition responded.}
36
-\item{\code{PosteriorDiff}:}{The difference in posterior response rates,
32
+\item{\code{PosteriorPs}:}{The posterior estimate of the proportion of cells in the stimulated sample.}
33
+\item{\code{PosteriorPu:}}{The posterior estimate of the proportio of cells in the unstimulated sample.}
34
+\item{\code{PosteriorDiff}:}{The difference in posterior proportions,
37 35
 as described above.}
38
-\item{\code{PosteriorLogDiff}:}{The difference in the log response rates,
36
+\item{\code{PosteriorLogDiff}:}{The difference in the log posterior proportions,
39 37
 as described above.}
40 38
 }
41 39
 }