% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sequence-visualisations-extended.R
\name{plot_sequence_index}
\alias{plot_sequence_index}
\title{Plot a sequence index heatmap}
\usage{
plot_sequence_index(
  data,
  sequence_id_col = "sequence_id",
  order_col = "sequence_order",
  state_col = "state",
  sort_by = c("input", "length", "path"),
  state_levels = NULL,
  palette = "Dark 3",
  show_sequence_labels = TRUE,
  ...
)
}
\arguments{
\item{data}{Long-format sequence data or a prepared result.}

\item{sequence_id_col, order_col, state_col}{Core sequence columns.}

\item{sort_by}{\code{"input"}, \code{"length"}, or \code{"path"}.}

\item{state_levels}{Optional state ordering.}

\item{palette}{Base HCL palette.}

\item{show_sequence_labels}{Draw sequence identifiers.}

\item{...}{Additional arguments passed to \code{\link[graphics:image]{graphics::image()}}.}
}
\value{
The plotted state-code matrix, invisibly.
}
\description{
Plot a sequence index heatmap
}
\examples{
data <- data.frame(sequence_id = rep(c("a", "b"), each = 4L),
                   sequence_order = rep(1:4, 2L),
                   state = c("A", "B", "C", "D", "A", "C", "C", "D"))
plot_sequence_index(data)
}
