diff --git a/R/cluster.R b/R/cluster.R index 0952ce900..2710e37d7 100644 --- a/R/cluster.R +++ b/R/cluster.R @@ -24,8 +24,11 @@ #' \code{rowData} (or \code{colData}) where the data will be stored. #' (Default: \code{"clusters"}) #' +#' @param full \code{Logical scalar}. Specifies whether additional clustering +#' information should be stored in the object metadata. +#' #' @param ... Additional parameters to use altExps for example -#' @inheritParams bluster::clusterRows +#' @param BLUSPARAM A \link[bluster]{BlusterParam-class} object specifying the algorithm to use. #' @inheritParams runDMN #' @inheritParams transformAssay #' diff --git a/data/multimedia_data_demo.rda b/data/multimedia_data_demo.rda new file mode 100644 index 000000000..5a2727ff2 Binary files /dev/null and b/data/multimedia_data_demo.rda differ diff --git a/man/addCluster.Rd b/man/addCluster.Rd index 51696cf27..5173c231e 100644 --- a/man/addCluster.Rd +++ b/man/addCluster.Rd @@ -71,7 +71,7 @@ object.} \item{...}{Additional parameters to use altExps for example} -\item{BLUSPARAM}{A \linkS4class{BlusterParam} object specifying the algorithm to use.} +\item{BLUSPARAM}{A \link[bluster]{BlusterParam-class} object specifying the algorithm to use.} \item{assay.type}{\code{Character scalar}. Specifies the name of assay used in calculation.} @@ -91,7 +91,8 @@ Must be \code{'rows'} or \code{'cols'}.} \code{rowData} (or \code{colData}) where the data will be stored. (Default: \code{"clusters"})} -\item{full}{Logical scalar indicating whether the full clustering statistics should be returned for each method.} +\item{full}{\code{Logical scalar}. Specifies whether additional clustering +information should be stored in the object metadata.} \item{dimred}{\code{Character scalar} or \code{integer scalar}. Specifies dimension reduction results used in calculation. Either