% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sequence-visualisations-extended.R
\name{plot_sequence_entropy}
\alias{plot_sequence_entropy}
\title{Plot position-wise state entropy}
\usage{
plot_sequence_entropy(
  data,
  sequence_id_col = "sequence_id",
  order_col = "sequence_order",
  state_col = "state",
  base = 2,
  normalise = TRUE,
  ...
)
}
\arguments{
\item{data}{Long-format sequence data or a prepared result.}

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

\item{base}{Logarithm base.}

\item{normalise}{Divide entropy by the maximum entropy for the observed
alphabet.}

\item{...}{Additional arguments passed to \code{\link[graphics:plot]{graphics::plot()}}.}
}
\value{
A data frame of position-wise entropy values, invisibly.
}
\description{
Plot position-wise state entropy
}
\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_entropy(data)
}
