% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/distributional.R
\name{gb_dist_weighted_npv}
\alias{gb_dist_weighted_npv}
\title{Distributionally-weighted net present value}
\usage{
gb_dist_weighted_npv(
  cashflow,
  recipient_income,
  eta = 1.3,
  schedule = "standard",
  reference = "median",
  income_data = NULL,
  vintage = "2022",
  base_year = NULL
)
}
\arguments{
\item{cashflow}{Numeric vector of net cashflows (per period).}

\item{recipient_income}{Numeric vector. The income of the
recipient (or representative recipient cell) in each period.
Must have the same length as \code{cashflow}.}

\item{eta}{Numeric scalar. Default \code{1.3}.}

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

\item{reference}{Reference income strategy passed to
\code{gb_dist_weight()}.}

\item{income_data}{Optional reference income distribution.}

\item{vintage}{Methodology vintage label. Default \code{"2022"}.}

\item{base_year}{Optional integer base year stored on the result.}
}
\value{
A \code{gb_appraisal} object with extra fields \code{weights},
\code{eta}, and \code{unweighted_npv}.
}
\description{
Applies recipient-income distributional weights to a cashflow
before discounting under the STPR.
}
\examples{
# 5-year benefit stream of GBP 30 going to a low-decile recipient
gb_dist_weighted_npv(
  cashflow = rep(30, 5),
  recipient_income = rep(15000, 5),
  income_data = seq(10000, 100000, length.out = 10)
)
}
\references{
HM Treasury (2022). The Green Book, Annex A3 on
distributional analysis.
}
\seealso{
\code{\link[=gb_dist_weight]{gb_dist_weight()}}, \code{\link[=gb_npv]{gb_npv()}}.

Other distributional: 
\code{\link{gb_dist_weight}()}
}
\concept{distributional}
