% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/module1_preqc.R
\name{summarize_plate_setup}
\alias{summarize_plate_setup}
\title{Summarise how each plate in a run is set up}
\usage{
summarize_plate_setup(
  hts_raw,
  plate_col = "plate_id",
  type_col = "well_type",
  compound_col = "compound_id",
  col_col = "col",
  nc_label = "NC",
  pc_label = "PC",
  blank_label = "Blank",
  compound_label = "compound"
)
}
\arguments{
\item{hts_raw}{An \code{hts_raw} object from \code{\link[=read_hts_plate]{read_hts_plate()}} (or any well-level
data frame with plate, well-coordinate and well-type columns).}

\item{plate_col, type_col, compound_col, col_col}{Names of the plate,
well-type, compound and column-index columns. Defaults match
\code{\link[=read_hts_plate]{read_hts_plate()}} output.}

\item{nc_label, pc_label, blank_label, compound_label}{Well-type labels for the
four roles.}
}
\value{
A data frame with one row per plate and the columns \code{plate_id},
\code{n_wells}, \code{plate_format}, \code{n_rows}, \code{n_cols}, \code{n_nc}, \code{n_pc}, \code{n_blank},
\code{n_compound}, \code{n_unique_compound}, \code{nc_columns}, \code{pc_columns},
\code{blank_columns} and \code{compound_columns} (control/compound positions given as
compact column ranges such as \code{"3-11"}).
}
\description{
Reports, for every plate in an \code{hts_raw} object, how the plate is laid out:
its physical format, the number of wells of each role (negative/positive
controls, blanks and compounds), how many distinct compounds it carries, and
which columns the controls and compounds occupy. The positions are \strong{read
back from your own layout} (see \code{\link[=read_plate_layout]{read_plate_layout()}}) rather than assumed by
the package: because a screening run normally spans \strong{several plates at
once}, this is the quickest way to confirm that every plate carries the
layout you designed before QC and normalisation.
}
\examples{
raw <- read_hts_plate(hts_primary_raw)
# One row per plate; the run holds three 96-well plates here.
summarize_plate_setup(raw)

}
\seealso{
\code{\link[=read_hts_plate]{read_hts_plate()}}, \code{\link[=check_control_label]{check_control_label()}}, \code{\link[=calc_z_prime]{calc_z_prime()}}
}
