vein_report: Inventory function.

Description Usage Arguments Value Examples

View source: R/vein_report.R

Description

vein_report produces an structure of directories and scripts in order to run vein. It is required to know the vehicular composition of the fleet.

Usage

1
2
vein_report(author = "me", path = getwd(), traffic = TRUE, speed = TRUE,
  ef = "scaled", emissions = TRUE)

Arguments

author

Character; name of the author of the report.

path

Character; path where to create report.Rmd.

traffic

Logical; if TRUE writes traffic functions.

speed

Logical; if TRUE writes speed functions.

ef

Character; 'local', 'speed' or 'scaled'.

emissions

Logical; if TRUE writes emissions functions.

Value

report.Rmd.

Examples

1
2
3
4
5
6
7
8
## Not run: 
name <- file.path(tempdir())
vein::inventory(name, rush.hour = TRUE)
source(paste0(name, "/main.R"))
vein_report(author = "me", path = name)
rmarkdown::render(paste0(name, "/report.Rmd"))

## End(Not run)

atmoschem/veinreport documentation built on May 17, 2019, 6:39 p.m.