run_corrplot_analysis: Run correlation plot analysis

In kazeera/hourglass: This Package Provides Visualizations of Annotated Numeric Data

Run correlation plot analysis

Description

Makes multiple correlation plots in 1 PDF file, each group and all values (total plots >= 2)

Usage

run_corrplot_analysis(
  df,
  rowAnn_col = 1,
  out_dir = ".",
  labels = "",
  gradient_palette = "RdBu",
  plot_gg = T,
  corr_method = c("pairwise.complete.obs", "spearman"),
  pval.label = "p.signif"
)

Arguments

df	A data frame - first column: rowAnnotation column with groups, the rest of the columns are values.
rowAnn_col	A column index (numeric) or name in df indicating which groups to stratify by.
out_dir	The output directory where the plot will be saved, default is current working directory.
labels	A character vector of at least length 1 that will be collapsed for file name/plot titles.
gradient_palette	RColorBrewer palette. See RColorBrewer::display.brewer.all() for all options.
plot_gg	Should we use the function link{plot_corrplotgg} from this package? Otherwise, it uses link{plot_corrplot}.
corr_method	A character vector of 2 that correspond to "use" and "method" parameters in cor. The first defaults to "pairwise.complete.obs" and second should be one of "pearson","spearman","kendall".
pval.label	How to display p-values? Allowed values are "p.signif" (stars) and "p.format" (number).

See Also

Other plotting: plot_corrplot(), plot_corrplotgg(), plot_discrete_barplot(), plot_heatmap(), plot_het_barplot(), plot_indiv_boxplot(), plot_indiv_corrscatt(), plot_indiv_paired(), plot_overview_boxplot(), plot_overview_corr_scatt(), plot_profile_barplot()

kazeera/hourglass documentation built on April 5, 2025, 7:18 a.m.