From dfc6ef3fbf6ab4d1e46d8b172f79ba3e3fcf614e Mon Sep 17 00:00:00 2001 From: samuel-marsh Date: Thu, 26 Sep 2024 10:26:59 -0400 Subject: [PATCH] Update docs --- man/Plot_Pie_Proportions.Rd | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/man/Plot_Pie_Proportions.Rd b/man/Plot_Pie_Proportions.Rd index 567081e95..f1e63a373 100644 --- a/man/Plot_Pie_Proportions.Rd +++ b/man/Plot_Pie_Proportions.Rd @@ -6,7 +6,9 @@ \usage{ Plot_Pie_Proportions( seurat_object, - group_by_var = "Total", + group_by_var = "ident", + split.by = NULL, + num_columns = NULL, colors_use = NULL, ggplot_default_colors = FALSE, color_seed = 123 @@ -15,7 +17,11 @@ Plot_Pie_Proportions( \arguments{ \item{seurat_object}{Seurat object name.} -\item{group_by_var}{meta data column to classify samples (default = "Total"; totals across all samples).} +\item{group_by_var}{meta data column to classify samples (default = "ident" and will use \code{active.ident}.} + +\item{split.by}{meta data variable to use to split plots. Default is NULL which will plot across entire object.} + +\item{num_columns}{number of columns in plot. Only valid if \code{split.by} is not NULL.} \item{colors_use}{color palette to use for plotting.}