Browse code

Renaming log-likelihood getter

Former-commit-id: ba72fb532b2150670be19d59944b7b7c2b0e0ee8

Sean Corbett authored on 07/12/2018 22:44:42
Showing 3 changed files

... ...
@@ -1,8 +1,8 @@
1 1
 # Generated by roxygen2: do not edit by hand
2 2
 
3
-export()
4 3
 export(DeconX)
5 4
 export(available_models)
5
+export(bestLogLikelihood)
6 6
 export(celda)
7 7
 export(celdaGridSearch)
8 8
 export(celdaHeatmap)
... ...
@@ -50,11 +50,11 @@ setMethod("logLikelihoodHistory",
50 50
 #' @description Retrieves the final log-likelihood from all iterations of Gibbs sampling used to generate a celda model.
51 51
 #' @return Numeric. The log-likelihood at the final step of Gibbs sampling used to generate the model.
52 52
 #' @examples
53
-#' logLikelihood(celda.CG.mod)
53
+#' bestLogLikelihood(celda.CG.mod)
54 54
 #' @export
55
-setGeneric("logLikelihood",
56
-           function(celda.mod){ standardGeneric("logLikelihood") })
57
-setMethod("logLikelihood",
55
+setGeneric("bestLogLikelihood",
56
+           function(celda.mod){ standardGeneric("bestLogLikelihood") })
57
+setMethod("bestLogLikelihood",
58 58
            signature=c(celda.mod="celdaModel"),
59 59
            function(celda.mod){  celda.mod@finalLogLik  })
60 60
 
61 61
new file mode 100644
... ...
@@ -0,0 +1,17 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/all_generics.R
3
+\name{bestLogLikelihood}
4
+\alias{bestLogLikelihood}
5
+\title{Get the log-likelihood}
6
+\usage{
7
+bestLogLikelihood(celda.mod)
8
+}
9
+\value{
10
+Numeric. The log-likelihood at the final step of Gibbs sampling used to generate the model.
11
+}
12
+\description{
13
+Retrieves the final log-likelihood from all iterations of Gibbs sampling used to generate a celda model.
14
+}
15
+\examples{
16
+bestLogLikelihood(celda.CG.mod)
17
+}