Updated man pages to include balanced parameter

biobakery · Nov 21, 2024 · da354f7 · da354f7
1 parent 5f47739
commit da354f7
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/man/maaslin3.Rd b/man/maaslin3.Rd
@@ -57,7 +57,8 @@ maaslin3(input_data,
     max_pngs = 30,
     cores = 1,
     save_models = FALSE,
-    verbosity = 'FINEST')
+    verbosity = 'FINEST',
+    summary_plot_balanced = FALSE)
 }
 \arguments{
     \item{input_data}{A data frame of feature abundances or read counts or a
@@ -210,6 +211,11 @@ maaslin3(input_data,
     \item{save_models}{Whether to return the fit models and save them to an
     RData file.}
     \item{verbosity}{The level of verbosity for the \code{logging} package.}
+    \item{summary_plot_balanced}{If set to TRUE the summary plot will 
+    show the top N features of each variable included in 
+    \code{coef_plot_vars} where N is equal to: 
+    \code{ceiling(summary_plot_first_n/length(coef_plot_vars))}. Will error
+    if \code{coef_plot_vars} = \code{NULL}}
 }
 \value{
     A list containing the following items:

diff --git a/man/maaslin_plot_results.Rd b/man/maaslin_plot_results.Rd
@@ -32,7 +32,8 @@ maaslin_plot_results(output,
                     coef_plot_vars = NULL,
                     heatmap_vars = NULL,
                     plot_associations = TRUE,
-                    max_pngs = 30)
+                    max_pngs = 30,
+                    balanced=FALSE)
 }
 \arguments{
     \item{output}{The output folder to write results.}
@@ -95,6 +96,11 @@ maaslin_plot_results(output,
     associations.}
     \item{max_pngs}{The top \code{max_pngs} significant associations will be
     plotted.}
+    \item{balanced}{If set to TRUE the summary plot will 
+    show the top N features of each variable included in 
+    \code{coef_plot_vars} where N is equal to: 
+    \code{ceiling(summary_plot_first_n/length(coef_plot_vars))}. Will error
+    if \code{coef_plot_vars} = \code{NULL}}
 }
 \value{
 Results will be written to the \code{figures} folder within the folder

diff --git a/man/maaslin_plot_results_from_output.Rd b/man/maaslin_plot_results_from_output.Rd
@@ -32,7 +32,8 @@ maaslin_plot_results_from_output(output,
                                 coef_plot_vars = NULL,
                                 heatmap_vars = NULL,
                                 plot_associations = TRUE,
-                                max_pngs = 30)
+                                max_pngs = 30,
+                                balanced=FALSE)
 }
 \arguments{
     \item{output}{The output folder to write results.}
@@ -86,6 +87,11 @@ maaslin_plot_results_from_output(output,
     associations.}
     \item{max_pngs}{The top \code{max_pngs} significant associations will be
     plotted.}
+    \item{balanced}{If set to TRUE the summary plot will 
+    show the top N features of each variable included in 
+    \code{coef_plot_vars} where N is equal to: 
+    \code{ceiling(summary_plot_first_n/length(coef_plot_vars))}. Will error
+    if \code{coef_plot_vars} = \code{NULL}}
 }
 
 \value{