% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/print.efa_screen.R
\name{print.efa_screen}
\alias{print.efa_screen}
\alias{format.efa_screen}
\title{Print and format an efa_screen object}
\usage{
\method{print}{efa_screen}(x, digits = 3, ...)

\method{format}{efa_screen}(x, digits = 3, ...)
}
\arguments{
\item{x}{An object of class \code{efa_screen} (output from \code{\link[=efa_screen]{efa_screen()}}).}

\item{digits}{Integer. The number of decimal places the reported values are
rounded to. Default is 3.}

\item{...}{Not used; for consistency with the generic.}
}
\value{
\code{print()} returns its argument \code{x} invisibly. \code{format()} returns a
character vector with the report lines.
}
\description{
\code{print()} turns the factor-analysis screening diagnostics computed by
\code{\link[=efa_screen]{efa_screen()}} into a sectioned report with banded, colour-coded verdicts:
sampling adequacy and sphericity (the Kaiser-Meyer-Olkin measure and Bartlett's
test of sphericity), multicollinearity (the determinant and condition number of
the correlation matrix), the per-variable diagnostics, and, when raw data were
supplied, multivariate normality and multivariate outliers. It closes with a
consolidated list of actionable recommendations (for example, which items to
consider dropping, whether to prefer an ordinal or a robust estimator, and a
caveat that keeps an over-powered Bartlett's test from being over-trusted).
\code{format()} assembles the same report and returns it as a character vector;
\code{print()} is \code{cat(format(x), sep = "\\n")}. The lines follow the active console
theme, so they are plain when colours are disabled (for example when captured
into a file or stripped with \code{\link[cli:ansi_strip]{cli::ansi_strip()}}). \code{print()} does not draw a
plot.
}
\examples{
# From raw data
efa_screen(iris[, 1:4])

# From a correlation matrix (supply N for Bartlett's test of sphericity)
efa_screen(test_models$baseline$cormat, N = 500)

# format() returns the same lines as a character vector:
writeLines(format(efa_screen(test_models$baseline$cormat, N = 500)))

}
\seealso{
Other factor analysis suitability:
\code{\link[=efa_bartlett]{efa_bartlett()}},
\code{\link[=efa_kmo]{efa_kmo()}},
\code{\link[=efa_screen]{efa_screen()}}
}
\concept{factor analysis suitability}
