vein (version 1.1.3)

vein_notes: Notes with sysinfo

Description

vein_notes creates aa text file '.txt' for writting technical notes about this emissions inventory

Usage

vein_notes(
  notes,
  file = "README",
  yourname = Sys.info()["login"],
  title = "Notes for this VEIN run",
  approach = "Top Down",
  traffic = "Your traffic information",
  composition = "Your traffic information",
  ef = "Your information about emission factors",
  cold_start = "Your information about cold starts",
  evaporative = "Your information about evaporative emission factors",
  standards = "Your information about standards",
  mileage = "Your information about mileage"
)

Value

Writes a text file.

Arguments

notes

Character; vector of notes.

file

Character; Name of the file. The function will generate a file with an extension '.txt'.

yourname

Character; Name of the inventor compiler.

title

Character; Title of this file. For instance: "Vehicular Emissions Inventory of Region XX, Base year XX"

approach

Character; vector of notes.

traffic

Character; vector of notes.

composition

Character; vector of notes.

ef

Character; vector of notes.

cold_start

Character; vector of notes.

evaporative

Character; vector of notes.

standards

Character; vector of notes.

mileage

Character; vector of notes.

Examples

if (FALSE) {
#do not run
a <- "delete"
f <- vein_notes("notes", file = a)
file.remove(f)
}