Skip to content

Commit d35e8dc

Browse files
committed
DOC: a little more info on absolute_value parameter
1 parent 74af576 commit d35e8dc

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

R/multiscaleSVDxpts.R

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4813,7 +4813,8 @@ simlr.search <- function(
48134813
#' @param center boolean center the data before applying
48144814
#' @param scale boolean scale the data before applying
48154815
#' @param absolute_value boolean vector indicating whether to take abs of feature matrices ;
4816-
#' set to FALSE by default
4816+
#' set to FALSE by default; when using \code{antspymm_simlr}, the values should be set to TRUE;
4817+
#' this is not required but it makes sure that the feature weights are non-negative.
48174818
#' @param verbose boolean
48184819
#'
48194820
#' @return A list including (entry one) data frame with the original data frame combined with the projections (entry two) the new column names

man/apply_simlr_matrices.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)