% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rmcorr.R
\name{print.rmcorr_matrix}
\alias{print.rmcorr_matrix}
\alias{plot.rmcorr_matrix}
\alias{summary.rmcorr_matrix}
\alias{print.summary.rmcorr_matrix}
\title{Methods for rmcorr Matrix Objects}
\usage{
\method{print}{rmcorr_matrix}(
  x,
  digits = 4,
  n = NULL,
  topn = NULL,
  max_vars = NULL,
  width = NULL,
  show_ci = NULL,
  ...
)

\method{plot}{rmcorr_matrix}(
  x,
  title = "Repeated-measures correlation heatmap",
  low_color = "indianred1",
  high_color = "steelblue1",
  mid_color = "white",
  value_text_size = 4,
  show_value = TRUE,
  ...
)

\method{summary}{rmcorr_matrix}(
  object,
  n = NULL,
  topn = NULL,
  max_vars = NULL,
  width = NULL,
  show_ci = NULL,
  ...
)

\method{print}{summary.rmcorr_matrix}(
  x,
  digits = 4,
  n = NULL,
  topn = NULL,
  max_vars = NULL,
  width = NULL,
  show_ci = NULL,
  ...
)
}
\arguments{
\item{x}{An object of class \code{"rmcorr_matrix"} or
\code{"summary.rmcorr_matrix"}.}

\item{digits}{Number of significant digits to print.}

\item{n}{Optional row threshold for compact preview output.}

\item{topn}{Optional number of leading/trailing rows to show when truncated.}

\item{max_vars}{Optional maximum number of visible columns; \code{NULL} derives this
from console width.}

\item{width}{Optional display width; defaults to \code{getOption("width")}.}

\item{show_ci}{One of \code{"yes"} or \code{"no"}.}

\item{...}{Additional arguments passed to downstream methods.}

\item{title}{Plot title for \code{plot.rmcorr_matrix()}.}

\item{low_color, high_color, mid_color}{Colours used for negative, positive,
and midpoint values in the heatmap.}

\item{value_text_size}{Size of the overlaid numeric value labels in the
heatmap.}

\item{show_value}{Logical; if \code{TRUE} (default), overlay numeric values
on heatmap tiles when the plot type supports them.}

\item{object}{An object of class \code{"rmcorr_matrix"}.}
}
\description{
Print, summarize, and plot methods for repeated-measures
correlation matrix objects of class \code{"rmcorr_matrix"} and
\code{"summary.rmcorr_matrix"}.
}
