# Vehicular Emissions Inventories

## Documentation for package ‘vein’ version 1.0.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Code demos. Use demo() to run them.

## Help Pages

A C D E F G I L M N P R S T V W

## -- A --

add_lkm | Construction function to add unit km
add_miles | Construction function to add unit miles
add_polid | Add polygon id to lines road network
adt | Average daily traffic (ADT) from hourly traffic data.
age | Applies a survival rate to numeric new vehicles
age_hdv | Returns amount of vehicles at each age
age_ldv | Returns amount of vehicles at each age
age_moto | Returns amount of vehicles at each age
aw | Average Weight for hourly traffic data.

## -- C --

celsius | Construction function for Celsius temperature
check_nt | Check the max number of threads
cold_mileage | Fraction of mileage driven with a cold engine or catalizer below normal temperature
colplot | Function to plot columns of data.frames

## -- D --

decoder | Description data.frame for MOVES
dmonth | Number of days of the month

## -- E --

ef_cetesb | Emissions factors for Environment Company of Sao Paulo, Brazil (CETESB)
ef_china | Emissions factors from Chinese emissions guidelines
ef_china_det | Correction of Chinese emission factors by deterioration
ef_china_h | Correction of Chinese factors by altitude
ef_china_hu | Correction of Chinese emission factors by humidity
ef_china_long | Chinese emission factors by emissions standard
ef_china_s | Correction of Chinese emission factors by sulfur
ef_china_speed | Correction of Chinese emission factors by speed
ef_china_te | Correction of Chinese emission factors by temperature
ef_china_th | Correction of Chinese factors by humidity when temperature > 24
ef_eea | Emissions factors from European European Environment Agency
ef_evap | Evaporative emission factor
ef_fun | Experimental: Returns a function of Emission Factor by age of use
ef_hdv_scaled | Scaling constant with speed emission factors of Heavy Duty Vehicles
ef_hdv_speed | Emissions factors for Heavy Duty Vehicles based on average speed
ef_im | Emission factors deoending on accumulated mileage
ef_ldv_cold | Cold-Start Emissions factors for Light Duty Vehicles
ef_ldv_cold_list | List of cold start emission factors of Light Duty Vehicles
ef_ldv_scaled | Scaling constant with speed emission factors of Light Duty Vehicles
ef_ldv_speed | Emissions factors for Light Duty Vehicles and Motorcycles
ef_local | Local Emissions factors
ef_nitro | Emissions factors of N2O and NH3
ef_wear | Emissions factors from tyre, break and road surface wear
ef_whe | Emission factor that incorporates the effect of high emitters
emis | Estimation of emissions
EmissionFactors | Construction function for class "EmissionFactors"
EmissionFactorsList | Construction function for class "EmissionFactorsList"
Emissions | Construction function for class "Emissions"
EmissionsArray | Construction function for class "EmissionsArray"
emis_chem | (in development, needs checks) Aggregate emissions by lumped groups in chemical mechanism
emis_chem2 | Aggregate emissions by lumped groups in chemical mechanism
emis_china | Estimation with Chinese factors
emis_cold | Estimation of cold start emissions hourly for the of the week
emis_cold_td | Estimation of cold start emissions with top-down approach
emis_det | Determine deterioration factors for urban conditions
emis_dist | Allocate emissions into spatial objects (street emis to grid)
emis_evap | Estimation of evaporative emissions
emis_evap2 | Estimation of evaporative emissions 2
emis_grid | Allocate emissions into a grid returning point emissions or flux
emis_hot_td | Estimation of hot exhaust emissions with a top-down approach
emis_long | Estimation with long format
emis_merge | Merge several emissions files returning data-frames or 'sf' of lines
emis_order | Re-order the emission to match specific hours and days
emis_paved | Estimation of resuspension emissions from paved roads
emis_post | Post emissions
emis_source | A function to source vein scripts
emis_to_streets | Emis to streets distribute top-down emissions into streets
emis_wear | Emission estimation from tyre, brake and road surface wear

## -- F --

fe2015 | Emission factors from Environmental Agency of Sao Paulo CETESB
fkm | List of functions of mileage in km fro Brazilian fleet
fuel_corr | Correction due Fuel effects

## -- G --

get_project | Download vein project
GriddedEmissionsArray | Construction function for class "GriddedEmissionsArray"
grid_emis | Allocate emissions gridded emissions into streets (grid to emis street)

## -- I --

invcop | Helper function to copy and zip projects
inventory | Inventory function.

## -- L --

long_to_wide | Transform data.frame from long to wide format

## -- M --

make_grid | Creates rectangular grid for emission allocation
moves_ef | MOVES emission factors
moves_rpd | MOVES estimation of using rates per distance
moves_rpdy | MOVES estimation of using rates per distance by model year
moves_rpdy_meta | MOVES estimation of using rates per distance by model year
moves_rpdy_sf | MOVES estimation of using rates per distance by model year
moves_rpsy_meta | MOVES estimation of using rates per start by model year
moves_rpsy_sf | MOVES estimation of using rates per start by model year
moves_speed | Return speed bins according to US/EPA MOVES model
my_age | Returns amount of vehicles at each age

## -- N --

net | Road network of the west part of Sao Paulo city
netspeed | Calculate speeds of traffic network

## -- P --

pc_cold | Profile of Vehicle start patterns
pc_profile | Profile of traffic data 24 hours 7 n days of the week
plot.EmissionFactors | Construction function for class "EmissionFactors"
plot.EmissionFactorsList | Construction function for class "EmissionFactorsList"
plot.Emissions | Construction function for class "Emissions"
plot.EmissionsArray | Construction function for class "EmissionsArray"
plot.GriddedEmissionsArray | Construction function for class "GriddedEmissionsArray"
plot.Speed | Construction function for class "Speed"
plot.Vehicles | Construction function for class "Vehicles"
pollutants | Data.frame with pollutants names and molar mass used in VEIN
print.EmissionFactors | Construction function for class "EmissionFactors"
print.EmissionFactorsList | Construction function for class "EmissionFactorsList"
print.Emissions | Construction function for class "Emissions"
print.EmissionsArray | Construction function for class "EmissionsArray"
print.GriddedEmissionsArray | Construction function for class "GriddedEmissionsArray"
print.Speed | Construction function for class "Speed"
print.Vehicles | Construction function for class "Vehicles"
profiles | Profile of traffic data 24 hours 7 n days of the week

## -- R --

remove_units | Remove units

## -- S --

speciate | Speciation of emissions
Speed | Construction function for class "Speed"
split_emis | Split street emissions based on a grid
summary.EmissionFactors | Construction function for class "EmissionFactors"
summary.EmissionFactorsList | Construction function for class "EmissionFactorsList"
summary.Emissions | Construction function for class "Emissions"
summary.EmissionsArray | Construction function for class "EmissionsArray"
summary.GriddedEmissionsArray | Construction function for class "GriddedEmissionsArray"
summary.Speed | Construction function for class "Speed"
summary.Vehicles | Construction function for class "Vehicles"

## -- T --

temp_fact | Expansion of hourly traffic data
temp_veh | Expanded Vehicles data.frame by hour
to_latex | creates a .tex a table from a data.frame

## -- V --

Vehicles | Construction function for class "Vehicles"
vein_notes | Notes with sysinfo
vkm | Estimation of VKM

## -- W --

weekly | Re-order the emission to match specific hours and days
wide_to_long | Transform data.frame from wide to long format