% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/EFAtools-superseded.R
\name{EKC}
\alias{EKC}
\title{Empirical Kaiser criterion}
\usage{
EKC(
  x,
  N = NA,
  use = c("pairwise.complete.obs", "all.obs", "complete.obs", "everything",
    "na.or.complete"),
  cor_method = c("pearson", "spearman", "kendall", "poly", "tetra"),
  type = lifecycle::deprecated()
)
}
\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{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. Correlation computed from raw data: \code{"pearson"},
\code{"spearman"}, or \code{"kendall"} (passed to \code{\link[stats:cor]{stats::cor()}}), or \code{"poly"} /
\code{"tetra"} for polychoric / tetrachoric correlations of ordinal / binary data
(a two-step estimator). Default is \code{"pearson"}. Note that the EKC reference
values rest on the Marchenko-Pastur law for the eigenvalues of a sample
correlation matrix of independent variables, which assumes the sampling
behaviour of product-moment correlations; with \code{"poly"} / \code{"tetra"} (and, to a
lesser degree, the rank-based methods) the reference series is therefore an
approximation.}

\item{type}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} Accepted and ignored. It selected
between two ways to compute the reference values. The \code{"AM2019"} reference values
do not depend on the observed eigenvalues, so they do not apply the empirical
correction that defines the criterion, and they are no longer computed.}
}
\value{
An object of class \code{efa_retention}, identical to the value of
\code{\link[=efa_ekc]{efa_ekc()}}; 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{EKC()} has been superseded by \code{\link[=efa_ekc]{efa_ekc()}}, which is the recommended interface
going forward. It remains available and unchanged so existing code keeps working.
}
\seealso{
\code{\link[=efa_ekc]{efa_ekc()}}
}
