% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/render-pdf.R
\name{to_pdf_report}
\alias{to_pdf_report}
\title{Compose a multi-page PDF report from a RegionResult}
\usage{
to_pdf_report(
  result,
  path,
  title = NULL,
  include_network = TRUE,
  include_about = TRUE
)
}
\arguments{
\item{result}{A [`RegionResult-class`].}

\item{path}{Output PDF file path.}

\item{title}{Optional title override for the overview page.}

\item{include_network}{If `TRUE` (default), include the network page.}

\item{include_about}{If `TRUE` (default), include the methodology page.}
}
\value{
Invisibly returns `NULL`. The PDF is written to `path`.
}
\description{
Writes a US Letter landscape PDF with overview, venn+upset, statistics
tables, and (by default) network and methodology pages. Each page has a
footer with package version, generation timestamp, and page number.
}
\examples{
\donttest{
if (getRversion() >= "4.6") {
  result <- analyze(load_sample("dataset_real_cancer_drivers_4"))
  to_pdf_report(result, tempfile(fileext = ".pdf"))
}
}
}
