Package: greenbook 0.1.1

greenbook: HM Treasury Green Book Cost-Benefit Analysis Primitives

Implements cost-benefit analysis primitives from HM Treasury Green Book guidance (HM Treasury, 2022, 2026): the kinked Social Time Preference Rate (STPR), discount factors, net present value (NPV), equivalent annual cost, and real-terms rebasing using the GDP deflator. Designed for UK central government appraisal and evaluation. Bundled parameter tables carry vintage metadata for reproducibility.

Authors:Charles Coverdale [aut, cre]

greenbook_0.1.1.tar.gz
greenbook_0.1.1.zip(r-4.7-any)greenbook_0.1.1.zip(r-4.6-any)greenbook_0.1.1.zip(r-4.5-any)
greenbook_0.1.1.tgz(r-4.6-any)greenbook_0.1.1.tgz(r-4.5-any)
greenbook_0.1.1.tar.gz(r-4.7-any)greenbook_0.1.1.tar.gz(r-4.6-any)
greenbook_0.1.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
greenbook/json (API)

# Install 'greenbook' in R:
install.packages('greenbook', repos = c('https://charlescoverdale.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/charlescoverdale/greenbook/issues

On CRAN:

Conda:

4.78 score 5 scripts 272 downloads 34 exports 1 dependencies

Last updated from:9cd36df994. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develOK113
source / vignettesOK165
linux-releaseOK107
macos-releaseOK83
macos-oldrelOK89
windows-develOK82
windows-releaseOK74
windows-oldrelOK80
wasm-releaseOK101

Exports:gb_apply_obgb_appraisegb_carbon_npvgb_carbon_valuegb_categoriesgb_comparegb_cost_per_unitgb_data_versionsgb_deflatorgb_discountgb_discount_factorgb_dist_weightgb_dist_weighted_npvgb_eancgb_economic_casegb_headlinegb_metbgb_npvgb_optimism_biasgb_place_basedgb_progressiongb_qalygb_realgb_rebasegb_risk_registergb_schedule_tablegb_sensitivity_obgb_stprgb_to_excelgb_to_latexgb_to_wordgb_validategb_vpfgb_wellby

Dependencies:cli

Carbon and environmental valuation
Carbon values for appraisal | Net present value of an emissions path | Wellbeing valuation | Risk to life and health | Provenance
Rendered fromcarbon-and-environment.Rmdusingknitr::rmarkdown

Last update: 2026-04-26
Started: 2026-04-26

Getting started with greenbook
Why greenbook | The kinked STPR | Discount factors | Net present value | Equivalent annual net cost | Real-terms rebasing | What's next
Rendered fromgreenbook.Rmdusingknitr::rmarkdown

Last update: 2026-04-26
Started: 2026-04-26

Readme and manuals

Help Manual

Help pageTopics
Apply an optimism bias uplift to a cost streamgb_apply_ob
Full Green Book appraisal in one callgb_appraise
Net present value of an emissions pathgb_carbon_npv
DESNZ carbon value for appraisalgb_carbon_value
Available optimism bias categoriesgb_categories
Compare multiple appraisal optionsgb_compare
Cost per unit deliveredgb_cost_per_unit
Vintage of bundled parameter tablesgb_data_versions
GDP deflator factor between two yearsgb_deflator
Apply discount factors to a streamgb_discount
Discount factor under the kinked STPRgb_discount_factor
Distributional weight for a recipient incomegb_dist_weight
Distributionally-weighted net present valuegb_dist_weighted_npv
Equivalent annual net cost (or benefit)gb_eanc
Render an appraisal as a Five Case Model economic casegb_economic_case
One-page headline summary of an appraisalgb_headline
Apply Marginal Excess Tax Burden to public expendituregb_metb
Net present valuegb_npv
Optimism bias upper bound for a project categorygb_optimism_bias
Aggregate sub-projects into a place-based business casegb_place_based
Track an appraisal across SOC, OBC, and FBC stagesgb_progression
Value of a Quality-Adjusted Life Yeargb_qaly
Convert nominal values to realgb_real
Rebase a real-terms series to a different base yeargb_rebase
Build a risk register with monetised exposuregb_risk_register
Tibble of the STPR schedulegb_schedule_table
Optimism bias sensitivity sweepgb_sensitivity_ob
Social Time Preference Rategb_stpr
Export an appraisal to Excelgb_to_excel
Render an appraisal as a LaTeX tablegb_to_latex
Export an appraisal to Wordgb_to_word
Lint a Green Book appraisal for common errorsgb_validate
Value of Preventing a Fatalitygb_vpf
Wellbeing valuation in GBP (WELLBY)gb_wellby