rmcorr_methods: Methods for Pairwise rmcorr Objects

In matrixCorr: Collection of Correlation and Association Estimators

Methods for Pairwise rmcorr Objects

Description

Print, summarize, and plot methods for pairwise repeated-measures correlation objects of class "rmcorr" and "summary.rmcorr".

Usage

## S3 method for class 'rmcorr'
print(
  x,
  digits = 4,
  n = NULL,
  topn = NULL,
  max_vars = NULL,
  width = NULL,
  show_ci = NULL,
  ...
)

## S3 method for class 'rmcorr'
summary(
  object,
  n = NULL,
  topn = NULL,
  max_vars = NULL,
  width = NULL,
  show_ci = NULL,
  ...
)

## S3 method for class 'summary.rmcorr'
print(
  x,
  digits = 4,
  n = NULL,
  topn = NULL,
  max_vars = NULL,
  width = NULL,
  show_ci = NULL,
  ...
)

## S3 method for class 'rmcorr'
plot(
  x,
  title = NULL,
  point_alpha = 0.8,
  line_width = 0.8,
  show_legend = FALSE,
  show_value = TRUE,
  ...
)

Arguments

x	An object of class "rmcorr" or "summary.rmcorr".
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. For plot.rmcorr(), these are passed to ggplot2::theme().
object	An object of class "rmcorr".
title	Optional plot title for plot.rmcorr(). Defaults to a title containing the estimated repeated-measures correlation.
point_alpha	Alpha transparency for scatterplot points.
line_width	Line width for subject-specific fitted lines.
show_legend	Logical; if TRUE, shows the subject legend in the pairwise scatterplot.
show_value	Logical; included for a consistent plotting interface. Pairwise repeated-measures plots do not overlay numeric cell values, so this argument currently has no effect.

matrixCorr documentation built on April 18, 2026, 5:06 p.m.