Browse code

vam documentation

salzcamino authored on 19/10/2022 17:31:24
Showing 1 changed files

... ...
@@ -16,14 +16,14 @@
16 16
 #' \code{resultNamePrefix_CDF}. If this parameter is set to \code{NULL}, then
17 17
 #' \code{"VAM_geneSetCollectionName_"} will be used. Default \code{NULL}.
18 18
 #' @param center Boolean. If \code{TRUE}, values will be mean centered when
19
-#' computing the Mahalanobis statistic. Default \code{TRUE}.
19
+#' computing the Mahalanobis statistic. Default \code{FALSE}.
20 20
 #' @param gamma Boolean. If \code{TRUE}, a gamma distribution will be fit to
21 21
 #' the non-zero squared Mahalanobis distances computed from a row-permuted
22 22
 #' version of the gene expression matrix. The estimated gamma distribution will
23 23
 #' be used to compute a one-sided p-value for each cell. If \code{FALSE}, the
24 24
 #' p-value will be computed using the standard chi-square approximation for the
25 25
 #' squared Mahalanobis distance (or non-central if \code{center = FALSE}).
26
-#' Default \code{FALSE}.
26
+#' Default \code{TRUE}.
27 27
 #' @importFrom methods slot
28 28
 #' @return A \linkS4class{SingleCellExperiment} object with VAM metrics stored
29 29
 #' in \code{reducedDim} as \code{VAM_NameOfTheGeneset_Distance} and