|
1 | 1 | #' Mini-batch k-means clustering
|
2 | 2 | #'
|
3 | 3 | #' Run the mini-batch k-means \code{\link{mbkmeans}} function with the specified
|
4 |
| -#' number of centers within \code{\link{clusterRows}} from the |
5 |
| -#' \code{\link{bluster}} Bioconductor package. |
| 4 | +#' number of centers within \code{\link[bluster]{clusterRows}} from the |
| 5 | +#' \code{bluster} Bioconductor package. |
6 | 6 | #'
|
7 |
| -#' This function is deprecated. Please use the \code{MbkmeansParam} function in |
8 |
| -#' the \code{\link{bluster}} Bioconductor package. |
9 |
| -#' @name MbkmeansParam-class |
| 7 | +#' This function is deprecated. Please use the \code{\link[bluster]{MbkmeansParam} function in |
| 8 | +#' the \code{bluster} Bioconductor package. |
| 9 | +#' |
| 10 | +#' @param centers An integer scalar specifying the number of centers. |
| 11 | +#' Alternatively, a function that takes the number of observations and returns the number of centers. |
| 12 | +#' Note, the \code{\link{mbkmeans}} function uses the argument \code{clusters} argument to represent this argument. |
| 13 | +#' However, we use \code{centers} to match |
| 14 | +#' @param ... Further arguments to pass to \code{\link{mbkmeans}}. |
| 15 | +#' |
| 16 | +#' @name MbkmeansParam |
10 | 17 | #' @docType class
|
11 | 18 | #' @aliases
|
12 | 19 | #' show,MbkmeansParam-method
|
13 | 20 | NULL
|
14 | 21 |
|
15 | 22 | #' @export
|
16 |
| -#' @rdname MbkmeansParam-class |
| 23 | +#' @rdname MbkmeansParam |
17 | 24 | MbkmeansParam <- function(centers, ...) {
|
18 | 25 | .Deprecated("bluster::MbkmeansParam")
|
19 | 26 | bluster::MbkmeansParam(centers, ...)
|
|
0 commit comments