print.rmcorr_matrix: Methods for rmcorr Matrix Objects

Description

Print, summarize, and plot methods for repeated-measures correlation matrix objects of class "rmcorr_matrix" and "summary_rmcorr_matrix".

Usage

# S3 method for rmcorr_matrix
print(
  x,
  digits = 4,
  n = NULL,
  topn = NULL,
  max_vars = NULL,
  width = NULL,
  show_ci = NULL,
  ...
)
# S3 method for rmcorr_matrix
plot(
  x,
  title = "Repeated-measures correlation heatmap",
  low_color = "indianred1",
  high_color = "steelblue1",
  mid_color = "white",
  value_text_size = 4,
  show_value = TRUE,
  ...
)
# S3 method for rmcorr_matrix
summary(
  object,
  n = NULL,
  topn = NULL,
  max_vars = NULL,
  width = NULL,
  show_ci = NULL,
  ...
)
# S3 method for summary_rmcorr_matrix
print(
  x,
  digits = 4,
  n = NULL,
  topn = NULL,
  max_vars = NULL,
  width = NULL,
  show_ci = NULL,
  ...
)

Arguments

x: An object of class "rmcorr_matrix" or "summary_rmcorr_matrix".
digits: Number of significant digits to print.
n: Optional row threshold for compact preview output.
topn: Optional number of leading/trailing rows to show when truncated.
max_vars: Optional maximum number of visible columns; NULL derives this from console width.
width: Optional display width; defaults to getOption("width").
show_ci: One of "yes" or "no".
...: Additional arguments passed to downstream methods.
title: Plot title for plot.rmcorr_matrix().
low_color, high_color, mid_color: Colours used for negative, positive, and midpoint values in the heatmap.
value_text_size: Size of the overlaid numeric value labels in the heatmap.
show_value: Logical; if TRUE (default), overlay numeric values on heatmap tiles when the plot type supports them.
object: An object of class "rmcorr_matrix".