% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/module7_report.R
\name{generate_hts_report}
\alias{generate_hts_report}
\title{Generate an HTML screening report}
\usage{
generate_hts_report(
  params = list(),
  output_file = tempfile(fileext = ".html"),
  template = NULL,
  quiet = TRUE
)
}
\arguments{
\item{params}{A named list of objects made available to the report template
(passed as \code{params}), for example \code{list(hits = ranked, drc = drc)}.}

\item{output_file}{Output HTML path. Default a temporary file.}

\item{template}{Path to an \code{.Rmd} template. Defaults to the package template
in \code{inst/rmd/report_template.Rmd}.}

\item{quiet}{Passed to \code{\link[rmarkdown:render]{rmarkdown::render()}}. Default \code{TRUE}.}
}
\value{
The path to the rendered report, invisibly.
}
\description{
Renders a standard HTML analysis report from the bundled R Markdown template,
embedding the supplied QC, dose-response and heatmap results. Requires the
suggested \pkg{rmarkdown} package.
}
\examples{
\dontrun{
drc <- calc_drc_auc(fit_4pl_curve(import_dose_response(hts_dose_response,
  response_col = "viability", group_cols = "cell_line"),
  group_cols = "cell_line"))
params <- merge(extract_drc_params(drc), drc$meta[, c("curve_id", "auc")])
generate_hts_report(list(hits = rank_hit_compound(params)))
}

}
\seealso{
\code{\link[=export_hit_table]{export_hit_table()}}
}
