% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/nmfae.signed.R
\name{nmfae.signed.rank}
\alias{nmfae.signed.rank}
\title{Rank selection for nmfae.signed (paired rank, concise diagnostics)}
\usage{
nmfae.signed.rank(
  Y1,
  Y2 = Y1,
  rank = 1:5,
  detail = c("full", "fast"),
  plot = TRUE,
  ...
)
}
\arguments{
\item{Y1}{Endogenous matrix (\eqn{P_1 \times N}); may be signed.}

\item{Y2}{Exogenous matrix; defaults to \code{Y1}.}

\item{rank}{Integer vector of (paired) ranks to evaluate.}

\item{detail}{\code{"full"} (default) also runs element-wise CV
(\code{sigma.ecv}); \code{"fast"} skips it (plots r.squared and
eff.rank only, and recommends the R-squared elbow).}

\item{plot}{Logical; draw the diagnostics plot (default \code{TRUE}).}

\item{...}{Passed on to \code{\link{nmfae.signed}} and
\code{\link{nmfae.signed.ecv}}.}
}
\value{
A list with \code{rank.best} and \code{criteria}
(\code{rank}, \code{effective.rank}, \code{effective.rank.ratio},
\code{r.squared}, \code{sigma.ecv}).
}
\description{
Fits \code{\link{nmfae.signed}} with a \strong{paired} decoder/encoder
rank (\eqn{Q = R}) across a range of ranks and reports
\code{r.squared}, the effective rank (of the latent encoding \eqn{H}),
and the element-wise CV error \code{sigma.ecv}, with the same concise
plot as \code{\link{nmfkc.rank}}.  For a full \eqn{(Q, R)} grid use
\code{\link{nmfae.signed.ecv}}.
}
\references{
Roy, O., & Vetterli, M. (2007).  The effective rank: A measure of
effective dimensionality.  \emph{Proc. EUSIPCO}, 606--610.
(\code{effective.rank})
Wold, S. (1978).  Cross-validatory estimation of the number of
components in factor and principal components models.
\emph{Technometrics}, 20(4), 397--405. (\code{sigma.ecv})
}
\seealso{
\code{\link{nmfae.signed}}, \code{\link{nmfae.signed.ecv}},
\code{\link{nmfkc.rank}}
}
