% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pefa_methods.R
\name{print.pefa}
\alias{print.pefa}
\alias{summary.pefa}
\alias{print.summary.pefa}
\alias{plot.pefa}
\title{Methods for a PEFA factor-count sweep}
\usage{
\method{print}{pefa}(x, ...)

\method{summary}{pefa}(object, ...)

\method{print}{summary.pefa}(x, digits = 3, ...)

\method{plot}{pefa}(
  x,
  type = c("objective", "gain", "fit"),
  criterion = c("ELBO", "AIC", "BIC"),
  pct = FALSE,
  ...
)
}
\arguments{
\item{...}{Further arguments; for \code{plot()}, graphical arguments passed to
the first base plot in the selected display.}

\item{object, x}{A result returned by \code{\link[=pefa]{pefa()}}; for
\code{print.summary.pefa()}, the object returned by \code{summary()}.}

\item{digits}{Number of decimals used when printing measured quantities.}

\item{type}{Display: criterion trajectories (\code{"objective"}), one gain
trajectory (\code{"gain"}), or descriptive absolute and incremental fit
trajectories (\code{"fit"}).}

\item{criterion}{Criterion path. \code{"ELBO"}, \code{"AIC"}, or \code{"BIC"} for
\code{type = "objective"}; \code{"ELBO"} or \code{"BIC"} for \code{type = "gain"}, which has
no AIC path. Ignored when \code{type = "fit"}.}

\item{pct}{Gain view only. \code{FALSE} (the default) computes the raw oriented
gains \code{ELBO_to - ELBO_from} or \code{BIC_from - BIC_to} from \verb{$sweep};
\code{TRUE} reads the stored \code{ELBO_gain_pct} or \code{BIC_gain_pct} column of
\verb{$transitions}, which is \code{NA} for a path with no positive gain.}
}
\value{
\code{print()} and \code{plot()} return their input invisibly.
\code{summary()} returns a list of class \code{"summary.pefa"} with exactly the
components \code{window} (named integer \code{Kmin}, \code{Kmax}, \code{K0}), \code{sweep},
\code{transitions}, \code{persistence}, \code{ssl}, \code{settings}, and \code{nonconverged_K}
(an integer vector of the K values whose candidate did not converge,
\code{integer(0)} when all converged).
}
\description{
Descriptive readers for the object returned by \code{\link[=pefa]{pefa()}}. They report what
was fitted and measured and nothing else: no method selects, recommends, or
marks a factor count, and none draws a threshold, because the package owns
no count rule. Count rules, persistence thresholds, and collision policies
belong to the analysis that consumes this object.
}
\seealso{
\code{\link[=pefa]{pefa()}}, \code{\link[=ssl]{ssl()}}
}
