R: HM Treasury Green Book Cost-Benefit Analysis Primitives

# HM Treasury Green Book Cost-Benefit Analysis Primitives

## Documentation for package ‘greenbook’ version 0.1.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

gb_apply_ob | Apply an optimism bias uplift to a cost stream
gb_appraise | Full Green Book appraisal in one call
gb_carbon_npv | Net present value of an emissions path
gb_carbon_value | DESNZ carbon value for appraisal
gb_categories | Available optimism bias categories
gb_compare | Compare multiple appraisal options
gb_cost_per_unit | Cost per unit delivered
gb_data_versions | Vintage of bundled parameter tables
gb_deflator | GDP deflator factor between two years
gb_discount | Apply discount factors to a stream
gb_discount_factor | Discount factor under the kinked STPR
gb_dist_weight | Distributional weight for a recipient income
gb_dist_weighted_npv | Distributionally-weighted net present value
gb_eanc | Equivalent annual net cost (or benefit)
gb_economic_case | Render an appraisal as a Five Case Model economic case
gb_headline | One-page headline summary of an appraisal
gb_metb | Apply Marginal Excess Tax Burden to public expenditure
gb_npv | Net present value
gb_optimism_bias | Optimism bias upper bound for a project category
gb_place_based | Aggregate sub-projects into a place-based business case
gb_progression | Track an appraisal across SOC, OBC, and FBC stages
gb_qaly | Value of a Quality-Adjusted Life Year
gb_real | Convert nominal values to real
gb_rebase | Rebase a real-terms series to a different base year
gb_risk_register | Build a risk register with monetised exposure
gb_schedule_table | Tibble of the STPR schedule
gb_sensitivity_ob | Optimism bias sensitivity sweep
gb_stpr | Social Time Preference Rate
gb_to_excel | Export an appraisal to Excel
gb_to_latex | Render an appraisal as a LaTeX table
gb_to_word | Export an appraisal to Word
gb_validate | Lint a Green Book appraisal for common errors
gb_vpf | Value of Preventing a Fatality
gb_wellby | Wellbeing valuation in GBP (WELLBY)