% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/matrixCorr-package.R
\docType{package}
\name{matrixCorr-package}
\alias{matrixCorr-package}
\alias{matrixCorr}
\alias{RcppExports}
\title{matrixCorr}
\description{
Correlation, agreement, and intraclass correlation estimators with a
consistent S3 interface.
}
\details{
\code{print()} methods provide compact previews and \code{summary()} methods provide
richer but still bounded digests. Truncation affects console display only;
full results remain available through direct extraction and coercion helpers
such as \code{as.matrix()}, \code{as.data.frame()}, and \code{tidy()} where implemented.

Package-wide display defaults can be controlled with options:
\itemize{
\item \code{matrixCorr.threads} (default \code{1L}; used as the default for
\code{n_threads} in thread-aware estimators)
\item \code{matrixCorr.print_max_rows} (default \code{20L})
\item \code{matrixCorr.print_topn} (default \code{5L})
\item \code{matrixCorr.print_max_vars} (default \code{NULL}, derived from console width)
\item \code{matrixCorr.print_show_ci} (default \code{"yes"})
\item \code{matrixCorr.summary_max_rows} (default \code{12L})
\item \code{matrixCorr.summary_topn} (default \code{5L})
\item \code{matrixCorr.summary_max_vars} (default \code{10L})
\item \code{matrixCorr.summary_show_ci} (default \code{"yes"})
}

Display methods validate user-facing arguments with \code{cli} conditions.
Confidence-interval visibility is explicit: \code{show_ci} accepts only \code{"yes"}
or \code{"no"}.

A common setup is:
\preformatted{
options(matrixCorr.threads = parallel::detectCores(logical = FALSE))
}
}
\seealso{
Useful links:
\itemize{
  \item \url{https://github.com/Prof-ThiagoOliveira/matrixCorr}
  \item Report bugs at \url{https://github.com/Prof-ThiagoOliveira/matrixCorr/issues}
}

}
\author{
\strong{Maintainer}: Thiago de Paula Oliveira \email{thiago.paula.oliveira@gmail.com} (\href{https://orcid.org/0000-0002-4555-2584}{ORCID})

}
\keyword{internal}
