% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lcmsPlot-class.R
\name{lp_purity_overlay}
\alias{lp_purity_overlay}
\title{Overlay precursor ion purity scores on a chromatogram}
\usage{
lp_purity_overlay(sample_ids = NULL, threshold = NULL, point_size = 2)
}
\arguments{
\item{sample_ids}{A \code{character} vector of sample IDs to include.
\code{NULL} uses all samples.}

\item{threshold}{A \code{numeric} value in \verb{[0, 1]} drawn as a reference
on the colour scale midpoint. \code{NULL} defaults to \code{0.5}.}

\item{point_size}{A \code{numeric} value controlling the point size.}
}
\value{
A layer function for use with the \code{+} operator.
}
\description{
\code{lp_purity_overlay()} adds a \code{geom_point} layer to the chromatogram panel
where each triangle marks the retention time of an MS/MS fragmentation event,
coloured by the interpolated precursor ion purity (\code{inPurity}). Requires the
data object to be a \code{purityA} result from the msPurity package and
\code{lp_chromatogram()} to be called first.
}
