% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/module1_preqc.R
\name{calc_z_prime}
\alias{calc_z_prime}
\title{Compute per-plate Z' factors}
\usage{
calc_z_prime(
  hts_raw,
  signal_col = "signal",
  nc_label = "NC",
  pc_label = "PC",
  z_prime_min = 0.5
)
}
\arguments{
\item{hts_raw}{An \code{hts_raw} object.}

\item{signal_col}{Name of the signal column. Default \code{"signal"}.}

\item{nc_label, pc_label}{Well-type labels for the negative and positive
controls. Defaults \code{"NC"} and \code{"PC"}.}

\item{z_prime_min}{Acceptance threshold. Default \code{0.5}.}
}
\value{
A data frame with one row per plate: \code{plate_id}, \code{mean_nc},
\code{mean_pc}, \code{sd_nc}, \code{sd_pc}, \code{z_prime} and a logical \code{pass}.
}
\description{
Calculates the Z' (Z-prime) factor for each plate from its negative- and
positive-control populations and flags plates against an acceptance
threshold.
}
\examples{
raw <- read_hts_plate(hts_primary_raw)
calc_z_prime(raw)

}
\seealso{
\code{\link[=filter_valid_plates]{filter_valid_plates()}}, \code{\link[=plot_plate_qc]{plot_plate_qc()}}
}
