Browse code

remove arguments

zhewa authored on 15/10/2020 18:09:09
Showing 3 changed files

... ...
@@ -440,9 +440,6 @@ setMethod("celdaGridSearch",
440 440
 #'  \item celdaList object.}
441 441
 #' @param params List. List of parameters used to subset the matching celda
442 442
 #'  models in list \code{"celda_grid_search"} in \code{metadata(x)}.
443
-#' @param useAssay A string specifying which \code{assay}
444
-#'  slot to use if \code{x} is a
445
-#'  \linkS4class{SingleCellExperiment} object. Default "counts".
446 443
 #' @param altExpName The name for the \link[SingleCellExperiment]{altExp} slot
447 444
 #'  to use. Default "featureSubset".
448 445
 #' @param ... Ignored. Placeholder to prevent check warning.
... ...
@@ -479,7 +476,7 @@ setGeneric("subsetCeldaList", function(x, ...) {
479 476
 #' @export
480 477
 setMethod("subsetCeldaList",
481 478
     signature(x = "SingleCellExperiment"),
482
-    function(x, params, useAssay = "counts", altExpName = "featureSubset") {
479
+    function(x, params, altExpName = "featureSubset") {
483 480
 
484 481
         ## Check for bad parameter names
485 482
         if (!all(names(params) %in% colnames(runParams(x,
... ...
@@ -584,9 +581,6 @@ setMethod("subsetCeldaList",
584 581
 #'  best model as a
585 582
 #'  \code{celdaList} object or not. If \code{FALSE}, return the best model as a
586 583
 #'  corresponding celda model object.
587
-#' @param useAssay A string specifying which \code{assay}
588
-#'  slot to use if \code{x} is a
589
-#'  \linkS4class{SingleCellExperiment} object. Default "counts".
590 584
 #' @param altExpName The name for the \link[SingleCellExperiment]{altExp} slot
591 585
 #'  to use. Default "featureSubset".
592 586
 #' @param ... Ignored. Placeholder to prevent check warning.
... ...
@@ -620,8 +614,7 @@ setGeneric("selectBestModel", function(x, ...) {
620 614
 #' @importFrom data.table as.data.table
621 615
 #' @export
622 616
 setMethod("selectBestModel", signature(x = "SingleCellExperiment"),
623
-    function(x, asList = FALSE, useAssay = "counts",
624
-        altExpName = "featureSubset") {
617
+    function(x, asList = FALSE, altExpName = "featureSubset") {
625 618
 
626 619
         altExp <- SingleCellExperiment::altExp(x, altExpName)
627 620
         logLikelihood <- NULL
... ...
@@ -8,12 +8,7 @@
8 8
 \usage{
9 9
 selectBestModel(x, ...)
10 10
 
11
-\S4method{selectBestModel}{SingleCellExperiment}(
12
-  x,
13
-  asList = FALSE,
14
-  useAssay = "counts",
15
-  altExpName = "featureSubset"
16
-)
11
+\S4method{selectBestModel}{SingleCellExperiment}(x, asList = FALSE, altExpName = "featureSubset")
17 12
 
18 13
 \S4method{selectBestModel}{celdaList}(x, asList = FALSE)
19 14
 }
... ...
@@ -33,10 +28,6 @@ best model as a
33 28
 \code{celdaList} object or not. If \code{FALSE}, return the best model as a
34 29
 corresponding celda model object.}
35 30
 
36
-\item{useAssay}{A string specifying which \code{assay}
37
-slot to use if \code{x} is a
38
-\linkS4class{SingleCellExperiment} object. Default "counts".}
39
-
40 31
 \item{altExpName}{The name for the \link[SingleCellExperiment]{altExp} slot
41 32
 to use. Default "featureSubset".}
42 33
 }
... ...
@@ -9,7 +9,7 @@
9 9
 \usage{
10 10
 subsetCeldaList(x, ...)
11 11
 
12
-\S4method{subsetCeldaList}{SingleCellExperiment}(x, params, useAssay = "counts", altExpName = "featureSubset")
12
+\S4method{subsetCeldaList}{SingleCellExperiment}(x, params, altExpName = "featureSubset")
13 13
 
14 14
 \S4method{subsetCeldaList}{celdaList}(x, params)
15 15
 }
... ...
@@ -27,10 +27,6 @@ subsetCeldaList(x, ...)
27 27
 \item{params}{List. List of parameters used to subset the matching celda
28 28
 models in list \code{"celda_grid_search"} in \code{metadata(x)}.}
29 29
 
30
-\item{useAssay}{A string specifying which \code{assay}
31
-slot to use if \code{x} is a
32
-\linkS4class{SingleCellExperiment} object. Default "counts".}
33
-
34 30
 \item{altExpName}{The name for the \link[SingleCellExperiment]{altExp} slot
35 31
 to use. Default "featureSubset".}
36 32
 }