From 9e0e3833f50a17cbe02959d7ffd04ca29ba1b640 Mon Sep 17 00:00:00 2001 From: Kdreval Date: Thu, 19 May 2022 19:01:50 -0700 Subject: [PATCH] cleanup: update documentation --- R/viz.R | 4 +++- man/prettyCoOncoplot.Rd | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/R/viz.R b/R/viz.R index 0bcd92b8..61bdda78 100644 --- 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 index 68073adc..8bb08c3a 100644 --- a/man/prettyCoOncoplot.Rd +++ b/man/prettyCoOncoplot.Rd @@ -39,7 +39,9 @@ annotate each oncoplot with it's own title that will be displayed at the top. Al 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 \code{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. } \examples{