% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/nmfae.signed.R
\name{nmfae.signed.heatmap}
\alias{nmfae.signed.heatmap}
\title{Heatmap visualization of nmfae.signed factor matrices}
\usage{
nmfae.signed.heatmap(
  x,
  Y1.label = NULL,
  X1.label = NULL,
  X2.label = NULL,
  Y2.label = NULL,
  palette.pos = NULL,
  palette.signed = NULL,
  show.C = TRUE,
  ...
)
}
\arguments{
\item{x}{An object of class \code{"nmfae.signed"}.}

\item{Y1.label}{Character vector for rows of \eqn{X_1}.}

\item{X1.label}{Decoder basis labels.}

\item{X2.label}{Encoder basis labels.}

\item{Y2.label}{Input variable labels.}

\item{palette.pos}{Palette for non-negative blocks. Default white-orange-red.}

\item{palette.signed}{Palette for signed \eqn{C}. Default blue-white-red.}

\item{show.C}{Logical. If \code{TRUE} (default), shows the combined
signed \eqn{C = C_{+} - C_{-}} as a separate panel.}

\item{...}{Not used.}
}
\value{
Invisible \code{NULL}. Called for its side effect (plot).
}
\description{
Displays the factor blocks of a \code{\link{nmfae.signed}} fit as
side-by-side heatmaps.  Non-negative blocks (\eqn{X_1, C_{+}, C_{-},
X_2}) use the white-orange-red palette; the signed combined
bottleneck \eqn{C = C_{+} - C_{-}} is rendered with a diverging
blue-white-red palette so positive and negative weights are visually
distinguishable.
}
\section{Lifecycle}{

This function is \strong{experimental}. The interface may change in
future versions.
}

\examples{
\donttest{
set.seed(1)
Y1 <- matrix(abs(rnorm(12)), 3, 4)
Y2 <- matrix(abs(rnorm(20)), 5, 4)
res <- nmfae.signed(Y1, Y2, rank = 2, rank.encoder = 2, maxit = 200)
nmfae.signed.heatmap(res)
}
}
\references{
Ding, C. H. Q., Li, T., & Jordan, M. I. (2010). Convex and
semi-nonnegative matrix factorizations. \emph{IEEE Transactions on
Pattern Analysis and Machine Intelligence}, 32(1), 45--55.
}
\seealso{
\code{\link{nmfae.signed}}, \code{\link{nmfae.heatmap}}
}
