% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/EFAtools-superseded.R
\name{NEST}
\alias{NEST}
\title{Next eigenvalue sufficiency test}
\usage{
NEST(
  x,
  N = NA,
  alpha = 0.05,
  use = c("pairwise.complete.obs", "all.obs", "complete.obs", "everything",
    "na.or.complete"),
  cor_method = c("pearson", "spearman", "kendall", "poly", "tetra"),
  n_datasets = 1000,
  ...
)
}
\arguments{
\item{x}{data.frame or matrix. Dataframe or matrix of raw data or matrix with
correlations.}

\item{N}{numeric. The number of observations. Only needed if x is a correlation
matrix. Must be larger than the number of variables.}

\item{alpha}{numeric. The alpha level to use (i.e., 1-alpha percentile of eigenvalues is used for reference values).}

\item{use}{character. Passed to \code{\link[stats:cor]{stats::cor()}} if raw
data is given as input. Default is "pairwise.complete.obs".}

\item{cor_method}{character. One of \code{"pearson"}, \code{"spearman"}, or \code{"kendall"},
passed to \code{\link[stats:cor]{stats::cor()}}. \code{"poly"} and \code{"tetra"} are not supported because
\code{NEST} compares the data against simulated continuous reference data.
Default is  \code{"pearson"}.}

\item{n_datasets}{numeric. The number of datasets to simulate. Default is 1000.}

\item{...}{Further arguments passed on to the \code{\link[=efa_fit]{efa_fit()}} fits. For example,
\code{estimator}, to change the estimator (PAF is default), or one of the estimation
tuning knobs (\code{type}, \code{init_comm}, \code{criterion}, \code{criterion_type}, \code{max_iter},
\code{abs_eigen}, \code{start_method}), which are repacked into an \code{\link[=estimate_control]{estimate_control()}}
object so that they tune the fits exactly as they always did.}
}
\value{
An object of class \code{efa_retention}, identical to the value of
\code{\link[=efa_nest]{efa_nest()}}; see there for the components.
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#superseded}{\figure{lifecycle-superseded.svg}{options: alt='[Superseded]'}}}{\strong{[Superseded]}}

\code{NEST()} has been superseded by \code{\link[=efa_nest]{efa_nest()}}, which is the recommended
interface going forward. It remains available and unchanged so existing code
keeps working.
}
\seealso{
\code{\link[=efa_nest]{efa_nest()}}
}
