cleanup: update documentation

morinlab · May 20, 2022 · 9e0e383 · 9e0e383
1 parent d699442
commit 9e0e383
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/R/viz.R b/R/viz.R
@@ -1633,7 +1633,9 @@ prettyOncoplot = function(maftools_obj,
 #' recognized by prettyOncoplot are supported and can be specified when calling this function.
 #' For both oncoplots the same specified parameters will be applied (e.g. genes to display, split columns,
 #' font size, top annotation etc). If the provided argument is not recognized by prettyOncoplot,
-#' it will be discarded. For developers: new arguments added to prettyOncoplot in the future
+#' it will be discarded. If you want a specific order of oncoplots on the left and right, please
+#' ensure the argument `comparison_column` is a factor with first level being the group
+#' you want to be plotted on the left side. For developers: new arguments added to prettyOncoplot in the future
 #' are expected to be out-of-the-box compatible with this function nd would not need code modifications.
 #'
 #' @param maf Required argument. A maftools object containing the mutations you want to plot on both oncoplots.

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