update plotIndiv doc to highlight group levels are important

mixOmicsTeam · Oct 21, 2024 · 244ba7d · 244ba7d
1 parent e221c35
commit 244ba7d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/R/plotIndiv.R b/R/plotIndiv.R
@@ -69,7 +69,8 @@
 #' @param group factor indicating the group membership for each sample, useful
 #' for ellipse plots. Coded as default for the supervised methods \code{PLS-DA,
 #' SPLS-DA,sGCCDA}, but needs to be input for the unsupervised methods
-#' \code{PCA, sPCA, IPCA, sIPCA, PLS, sPLS, rCC, rGCCA, sGCCA}
+#' \code{PCA, sPCA, IPCA, sIPCA, PLS, sPLS, rCC, rGCCA, sGCCA}. Order of levels will reflect
+#' order in legends and correspond to any set colours. 
 #' @template arg/col.per.group
 #' @param style argument to be set to either \code{'graphics'},
 #' \code{'lattice'}, \code{'ggplot2'} or \code{'3d'} for a style of plotting.

diff --git a/man/plotIndiv.Rd b/man/plotIndiv.Rd