% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/nmfae.R
\name{nmfae.rename}
\alias{nmfae.rename}
\title{Rename decoder and encoder bases}
\usage{
nmfae.rename(x, X1.colnames = NULL, X2.rownames = NULL)
}
\arguments{
\item{x}{An object of class \code{"nmfae"} returned by \code{\link{nmfae}}.}

\item{X1.colnames}{Character vector of length \eqn{Q} for decoder bases
(columns of \eqn{X_1} / rows of \eqn{\Theta}).  If \code{NULL}
(default), the decoder names are left unchanged.}

\item{X2.rownames}{Character vector of length \eqn{R} for encoder bases
(rows of \eqn{X_2} / columns of \eqn{\Theta}).  If \code{NULL}
(default), the encoder names are left unchanged.}
}
\value{
A modified copy of \code{x} with updated names.
}
\description{
Assigns user-specified names to the decoder (X1 columns) and encoder
(X2 rows) bases of an \code{nmfae} object.  The names propagate to
\eqn{\Theta}, the coefficients table, and all downstream displays
such as \code{summary}, \code{nmfae.DOT}, and \code{nmfae.heatmap}.
}
\examples{
\donttest{
set.seed(1)
Y <- matrix(runif(15), nrow = 3)
res <- nmfae(Y, rank = 2, rank.encoder = 2)
res <- nmfae.rename(res,
  X1.colnames = c("Basis1", "Basis2"),
  X2.rownames = c("Enc1", "Enc2"))
summary(res)
}
}
\seealso{
\code{\link{nmfae}}
}
