% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/summary_pdf.R
\name{generate_summary_pdf}
\alias{generate_summary_pdf}
\title{Generate a compact printable PDF summary of oystermapR results}
\usage{
generate_summary_pdf(
  result,
  output = "oyster_summary.pdf",
  species = "ostrea_edulis",
  title = "Oyster Suitability Summary",
  author = "",
  open = TRUE,
  verbose = TRUE
)
}
\arguments{
\item{result}{A dataframe returned by \code{\link[=predict_oyster]{predict_oyster()}}.}

\item{output}{Character. Output \code{.pdf} file path.
Default \code{"oyster_summary.pdf"}.}

\item{species}{Character. Species key used in \code{\link[=predict_oyster]{predict_oyster()}}.
Default \code{"ostrea_edulis"}.}

\item{title}{Character. Report title shown in the header.
Default \code{"Oyster Suitability Summary"}.}

\item{author}{Character. Author name (optional, shown in header).}

\item{open}{Logical. Open the PDF after writing (default \code{TRUE}).}

\item{verbose}{Logical. Print progress messages (default \code{TRUE}).}
}
\value{
The output file path (invisibly).
}
\description{
Produces a self-contained multi-page A4 PDF directly from the output of
\code{\link[=predict_oyster]{predict_oyster()}} without requiring LaTeX, pandoc, or Rmd rendering.
The PDF is designed for printing and contains four pages:
\itemize{
\item \strong{Page 1} -- Title header, executive summary table, class breakdown bar
\item \strong{Page 2} -- Suitability heatmap (survey points, continuous colour ramp)
\item \strong{Page 3} -- Per-variable mean score chart (horizontal bar)
\item \strong{Page 4} -- Score distribution histogram + class count bar chart
}
}
\examples{
\donttest{
result <- predict_oyster(survey_df, "ostrea_edulis")
generate_summary_pdf(result, "kames_bay_summary.pdf",
                     title  = "Kames Bay -- Spring Survey",
                     author = "T. Tucker")
}
}
