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

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

\item{digits}{Integer. The number of decimal places the coefficients are
rounded to (passed to \code{\link[base:round]{base::round()}}). 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()} shows the omega coefficients computed by \code{\link[=OMEGA]{OMEGA()}}: omega total (and,
for multi-factor solutions, omega hierarchical, omega subscale, the H index,
the explained common variance, and the percent of uncontaminated correlations)
for the general factor and the group factors, for a single group or for each
group. \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()}}).
}
\examples{
efa_mod <- efa_fit(test_models$baseline$cormat, N = 500, n_factors = 3,
                   estimator = "PAF", rotation = "promax")
sl_mod <- efa_schmid_leiman(efa_mod, estimator = "PAF")

om <- OMEGA(sl_mod, type = "EFAtools",
            factor_corres = sl_mod$sl[, c("F1", "F2", "F3")] >= .2)
om

# format() returns the same lines as a character vector:
writeLines(format(om))

}
