export_results: Output productivity impacts to an MS Word report or a csv...

Description Usage Arguments Value

View source: R/export_results.R

Description

This function takes the outputs of the discounted_prod and the prod_summary functions to produce an MS Word report or csv summary of the outputs.

Usage

1
2
3
4
5
6
7
8
9
export_results(
  benefits_summary,
  benefits_discounted,
  output_format = c("report", "csv"),
  scheme_name,
  scheme_scenario,
  scheme_opening_year,
  report_date
)

Arguments

benefits_summary

the R object output by the prod_summary function

benefits_discounted

the R object output by the discounted_prod function

output_format

specify the output format as "report" for an MS Word report or "csv" for a csv table of the discounted benefits by year.

scheme_name

input a text string with the scheme name to be included in the MS Word report

scheme_scenario

input a text string describing the scenario being tested be included in the MS Word report

scheme_opening_year

specify the scheme opening year

report_date

input the date to be included in the MS Word report

Value

An MS Word report summary or a csv table of results of agglomeration impacts. Allows the user to interactively set file name. N.B. ensure that correct file extension is specified, i.e. .csv or .docx


TII-STP/pagglomR documentation built on Jan. 12, 2022, 4:04 p.m.