% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/appraise.R
\name{gb_appraise}
\alias{gb_appraise}
\title{Full Green Book appraisal in one call}
\usage{
gb_appraise(
  costs,
  benefits,
  years = NULL,
  schedule = "standard",
  ob = NULL,
  ob_dimension = "capex",
  ob_mitigation = 0,
  metb = FALSE,
  metb_rate = 0.2,
  base_year = NULL,
  vintage = "2022"
)
}
\arguments{
\item{costs}{Numeric vector of cost values per period (real
terms, base year fixed). Sign convention: enter as positive
numbers; \code{gb_appraise()} handles the netting.}

\item{benefits}{Numeric vector of benefit values per period.
Same length as \code{costs}.}

\item{years}{Optional integer vector of years. Defaults to
\code{0:(length(costs) - 1)}.}

\item{schedule}{One of \code{"standard"}, \code{"health"}, \code{"catastrophic"}.}

\item{ob}{Optional. Either a category name (character) or a
numeric percentage. If supplied, optimism bias uplift is
applied to \code{costs}.}

\item{ob_dimension}{One of \code{"capex"} (default) or \code{"duration"}.
Only used when \code{ob} is a category name.}

\item{ob_mitigation}{Numeric in \verb{[0, 1]}. Mitigation fraction.}

\item{metb}{Logical. If \code{TRUE}, applies METB uplift to costs.}

\item{metb_rate}{Numeric. METB rate when \code{metb = TRUE}. Default
\code{0.20} per Green Book 2022.}

\item{base_year}{Optional integer base year.}

\item{vintage}{Methodology vintage label. Default \code{"2022"}.}
}
\value{
A \code{gb_appraisal} object with extra fields \code{bcr},
\code{pv_costs}, \code{pv_benefits}, \code{costs}, \code{benefits},
\code{optimism_bias}, \code{metb_applied}.
}
\description{
Runs an end-to-end appraisal: optionally applies optimism bias to
costs, optionally applies METB, computes NPV under the kinked
STPR, and returns BCR alongside provenance.
}
\examples{
costs <- c(100, 50, 50, 0, 0, 0, 0, 0, 0, 0)
benefits <- c(0, 0, 0, 30, 30, 30, 30, 30, 30, 30)
app <- gb_appraise(costs, benefits, ob = "non_standard_buildings",
                   ob_mitigation = 0.5, base_year = 2024)
app
}
\references{
HM Treasury (2026). The Green Book: Central Government Guidance
on Appraisal and Evaluation.
}
\seealso{
\code{\link[=gb_npv]{gb_npv()}}, \code{\link[=gb_optimism_bias]{gb_optimism_bias()}}, \code{\link[=gb_metb]{gb_metb()}},
\code{\link[=gb_dist_weighted_npv]{gb_dist_weighted_npv()}}.

Other appraisal: 
\code{\link{gb_compare}()},
\code{\link{gb_economic_case}()},
\code{\link{gb_place_based}()},
\code{\link{gb_progression}()},
\code{\link{gb_risk_register}()},
\code{\link{gb_sensitivity_ob}()},
\code{\link{gb_validate}()}
}
\concept{appraisal}
