% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/reporting.R
\name{gb_headline}
\alias{gb_headline}
\title{One-page headline summary of an appraisal}
\usage{
gb_headline(appraisal)
}
\arguments{
\item{appraisal}{A \code{gb_appraisal} object.}
}
\value{
A \code{gb_headline} object with elements \code{npv}, \code{bcr},
\code{eanc}, \code{payback_year}, \code{optimism_bias}, \code{metb_applied},
\code{vintage}, \code{base_year}, \code{horizon}.
}
\description{
Returns the headline numbers a Green Book reviewer or steering
committee expects: NPV, BCR, EANC, payback period, optimism bias
applied, vintage. Suitable for a slide or executive summary.
}
\examples{
app <- gb_appraise(c(100, 0, 0, 0, 0), c(0, 30, 30, 30, 30))
gb_headline(app)
}
\seealso{
\code{\link[=gb_appraise]{gb_appraise()}}, \code{\link[=gb_to_latex]{gb_to_latex()}}, \code{\link[=gb_to_excel]{gb_to_excel()}}.

Other reporting: 
\code{\link{gb_cost_per_unit}()},
\code{\link{gb_to_excel}()},
\code{\link{gb_to_latex}()},
\code{\link{gb_to_word}()}
}
\concept{reporting}
