% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/module1_preqc.R
\name{plot_plate_qc}
\alias{plot_plate_qc}
\title{Visualise any plate quality-control metric}
\usage{
plot_plate_qc(qc, metric = "z_prime", threshold = NULL, plate_col = "plate_id")
}
\arguments{
\item{qc}{A data frame from \code{\link[=calc_plate_qc]{calc_plate_qc()}} for the plate-level metrics, or
from \code{\link[=calc_well_zscore]{calc_well_zscore()}} for the per-well \code{zscore}/\code{robust_zscore}
distributions.}

\item{metric}{The metric to plot: one of \code{"z_prime"}, \code{"robust_z_prime"},
\code{"z_factor"}, \code{"ssmd"}, \code{"sb"}, \code{"sn"}, \code{"cv_nc"}, \code{"cv_pc"}, \code{"cv"} (both
control CVs side by side), or \code{"zscore"}/\code{"robust_zscore"} for per-well
distributions. Default \code{"z_prime"}.}

\item{threshold}{Optional acceptance threshold drawn as a reference line;
defaults to the standard cut-off for the chosen metric.}

\item{plate_col}{Name of the plate-identifier column. Default \code{"plate_id"}.}
}
\value{
A \link[ggplot2:ggplot]{ggplot2::ggplot} object.
}
\description{
A single entry point for plotting the plate-quality metrics produced by
\code{\link[=calc_plate_qc]{calc_plate_qc()}} (and the per-well scores from \code{\link[=calc_well_zscore]{calc_well_zscore()}}). Choose
which assessment to draw through the \code{metric} argument; the acceptance
threshold, axis label and pass/fail colouring are set automatically for each
metric but can be overridden.
}
\examples{
raw <- read_hts_plate(hts_primary_raw)
qc <- calc_plate_qc(raw)
plot_plate_qc(qc, metric = "z_prime")
plot_plate_qc(qc, metric = "ssmd")
plot_plate_qc(qc, metric = "cv")
plot_plate_qc(calc_well_zscore(raw), metric = "robust_zscore")

}
\seealso{
\code{\link[=calc_plate_qc]{calc_plate_qc()}}, \code{\link[=calc_well_zscore]{calc_well_zscore()}}, \code{\link[=plot_plate_heatmap_raw]{plot_plate_heatmap_raw()}}
}
