diff --git a/.Rbuildignore b/.Rbuildignore index f87f2c45..78b9865e 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -14,3 +14,4 @@ ^README.md$ ^.github$ ^all_comp.gif$ +^pkgdown$ diff --git a/docs/404.html b/docs/404.html index 6a115398..dce69650 100644 --- a/docs/404.html +++ b/docs/404.html @@ -15,13 +15,11 @@ - - @@ -41,14 +39,13 @@ - + - @@ -95,6 +92,7 @@ Changelog + @@ -127,7 +125,7 @@

Page not found (404)

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html index 9a6eb713..1f2e99a5 100644 --- a/docs/CODE_OF_CONDUCT.html +++ b/docs/CODE_OF_CONDUCT.html @@ -15,13 +15,11 @@ - - @@ -41,14 +39,13 @@ - + - @@ -95,6 +92,7 @@ Changelog + @@ -175,7 +173,7 @@

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html index b68e1b02..b6300578 100644 --- a/docs/CONTRIBUTING.html +++ b/docs/CONTRIBUTING.html @@ -15,13 +15,11 @@ - - @@ -41,14 +39,13 @@ - + - @@ -95,6 +92,7 @@ Changelog + @@ -177,7 +175,7 @@

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 9dbcf4f2..79a32c10 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -15,13 +15,11 @@ - - @@ -41,14 +39,13 @@ - + - @@ -95,6 +92,7 @@ Changelog + @@ -129,7 +127,7 @@

License

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/authors.html b/docs/authors.html index bf15afcf..5afd0065 100755 --- a/docs/authors.html +++ b/docs/authors.html @@ -15,13 +15,11 @@ - - @@ -41,14 +39,13 @@ - + - @@ -95,6 +92,7 @@ Changelog + @@ -138,7 +136,6 @@

Citation

note = {R package version 0.8.0}, url = {https://atmoschem.github.io/vein/}, } - @@ -166,7 +163,7 @@

Authors

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/index.html b/docs/index.html index 6ad2c2a0..6583a7f6 100755 --- a/docs/index.html +++ b/docs/index.html @@ -530,7 +530,7 @@

Developers

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/news/index.html b/docs/news/index.html index 3d801df3..0d4e7584 100755 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -15,13 +15,11 @@ - - @@ -41,14 +39,13 @@ - + - @@ -95,6 +92,7 @@ Changelog + @@ -1134,7 +1132,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 4bf19af7..87eb8fe8 100755 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,5 +1,5 @@ pandoc: 2.3.1 -pkgdown: 1.4.0 +pkgdown: 1.4.1 pkgdown_sha: ~ articles: [] urls: diff --git a/docs/reference/EmissionFactors.html b/docs/reference/EmissionFactors.html index c8575cd5..8aeaa9a1 100755 --- a/docs/reference/EmissionFactors.html +++ b/docs/reference/EmissionFactors.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,8 +117,10 @@

Construction function for class "EmissionFactors"

+

EmissionFactors returns a tranformed object with class "EmissionFactors" and units g/km.

+
EmissionFactors(x, ...)
@@ -132,7 +133,7 @@ 

Construction function for class "EmissionFactors"

# S3 method for EmissionFactors plot(x, ...)
- +

Arguments

@@ -149,10 +150,11 @@

Arg

Object with class "EmissionFactors"

- +

Value

Objects of class "EmissionFactors" or "units"

+

Examples

{ @@ -184,7 +186,9 @@

Examp

Contents

@@ -198,7 +202,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/EmissionFactorsList.html b/docs/reference/EmissionFactorsList.html index fe0f7a5a..63931f39 100755 --- a/docs/reference/EmissionFactorsList.html +++ b/docs/reference/EmissionFactorsList.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,8 +117,10 @@

Construction function for class "EmissionFactorsList"

+

EmissionFactorsList returns a tranformed object with class"EmissionsFactorsList".

+
EmissionFactorsList(x, ...)
@@ -132,7 +133,7 @@ 

Construction function for class "EmissionFactorsList"

# S3 method for EmissionFactorsList plot(x, ...)
- +

Arguments

@@ -154,10 +155,11 @@

Arg

Object with class "EmissionFactorsList"

- +

Value

Objects of class "EmissionFactorsList"

+

Examples

{ @@ -181,7 +183,9 @@

Examp

Contents

@@ -195,7 +199,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/Emissions.html b/docs/reference/Emissions.html index c2104519..33c8e28b 100755 --- a/docs/reference/Emissions.html +++ b/docs/reference/Emissions.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,10 +119,12 @@

Construction function for class "Emissions"

+

Emissions returns a tranformed object with class "Emissions". The type of objects supported are of classes "matrix", "data.frame" and "numeric". If the class of the object is "matrix" this function returns a dataframe.

+
Emissions(x, ...)
@@ -136,7 +137,7 @@ 

Construction function for class "Emissions"

# S3 method for Emissions plot(x, ...)
- +

Arguments

@@ -153,10 +154,11 @@

Arg

object with class "Emissions"

- +

Value

Objects of class "Emissions" or "units"

+

Examples

if (FALSE) { @@ -196,7 +198,9 @@

Examp

Contents

@@ -210,7 +214,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/EmissionsArray.html b/docs/reference/EmissionsArray.html index 7a6e4432..8e3b26a3 100755 --- a/docs/reference/EmissionsArray.html +++ b/docs/reference/EmissionsArray.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,8 +117,10 @@

Construction function for class "EmissionsArray"

+

EmissionsArray returns a tranformed object with class "EmissionsArray" with 4 dimensios.

+
EmissionsArray(x, ...)
@@ -132,7 +133,7 @@ 

Construction function for class "EmissionsArray"

# S3 method for EmissionsArray plot(x, ...)
- +

Arguments

@@ -149,13 +150,15 @@

Arg

object with class "EmissionsArray'

- +

Value

Objects of class "EmissionsArray"

+

Note

Future version of this function will return an Array of 3 dimensions.

+

Examples

if (FALSE) { @@ -195,8 +198,11 @@

Examp

Contents

@@ -210,7 +216,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/GriddedEmissionsArray.html b/docs/reference/GriddedEmissionsArray.html index 027b3741..137b21ea 100644 --- a/docs/reference/GriddedEmissionsArray.html +++ b/docs/reference/GriddedEmissionsArray.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,8 +117,10 @@

Construction function for class "GriddedEmissionsArray"

+

GriddedEmissionsArray returns a tranformed object with class "EmissionsArray" with 4 dimensios.

+
GriddedEmissionsArray(x, ..., cols, rows, times = ncol(x),
@@ -133,7 +134,7 @@ 

Construction function for class "GriddedEmissionsArray"

# S3 method for GriddedEmissionsArray plot(x, ..., times = 1)
- +

Arguments

@@ -167,10 +168,11 @@

Arg

object with class "EmissionsArray'

- +

Value

Objects of class "GriddedEmissionsArray"

+

Examples

if (FALSE) { @@ -211,7 +213,7 @@

Examp plot(gr) # For some cptcity color gradients: -devtools::install_github("ibarraespinosa/cptcity") +devtools::install_github("ibarraespinosa/cptcity") plot(gr, col = cptcity::cptcity(1)) }

@@ -219,7 +221,9 @@

Examp

Contents

@@ -233,7 +237,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/Speed.html b/docs/reference/Speed.html index 4ba55e51..c5d34eca 100755 --- a/docs/reference/Speed.html +++ b/docs/reference/Speed.html @@ -15,13 +15,11 @@ - - @@ -41,19 +39,19 @@ - + + - @@ -100,6 +98,7 @@ Changelog + @@ -121,11 +120,13 @@

Construction function for class "Speed"

+

Speed returns a tranformed object with class "Speed" and units km/h. This functions includes two arguments, distance and time. Therefore, it is posibel to change the units of the speed to "m" to "s" for example. This function returns a dataframe with units for speed. When this function is applied to numeric vectors it add class "units".

+
Speed(x, ...)
@@ -138,7 +139,7 @@ 

Construction function for class "Speed"

# S3 method for Speed plot(x, ...)
- +

Arguments

@@ -155,13 +156,15 @@

Arg

Object with class "Speed"

- +

Value

Constructor for class "Speed" or "units"

+

See also

+

Examples

{ @@ -181,8 +184,11 @@

Examp

Contents

@@ -196,7 +202,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/Vehicles.html b/docs/reference/Vehicles.html index 3907a39b..0838cd4f 100755 --- a/docs/reference/Vehicles.html +++ b/docs/reference/Vehicles.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,10 +119,12 @@

Construction function for class "Vehicles"

+

Vehicles returns a tranformed object with class "Vehicles" and units 'veh'. The type of objects supported are of classes "matrix", "data.frame", "numeric" and "array". If the object is a matrix it is converted to data.frame. If the object is "numeric" it is converted to class "units".

+
Vehicles(x, ...)
@@ -136,7 +137,7 @@ 

Construction function for class "Vehicles"

# S3 method for Vehicles plot(x, ..., message = TRUE)
- +

Arguments

@@ -157,10 +158,11 @@

Arg

message with average age

- +

Value

Objects of class "Vehicles" or "units"

+

Examples

{ @@ -197,7 +199,9 @@

Examp

Contents

@@ -211,7 +215,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/add_polid.html b/docs/reference/add_polid.html index 5f6d4e51..4bee95f4 100644 --- a/docs/reference/add_polid.html +++ b/docs/reference/add_polid.html @@ -15,13 +15,11 @@ - - @@ -41,17 +39,17 @@ - + + - @@ -98,6 +96,7 @@ Changelog + @@ -119,13 +118,15 @@

Add polygon id to lines road network

+

Sometimes you need to add polygon id into your streets road network. add_polid add add_polid id into your road network cropping your network by

+
add_polid(polyg, street, by)
- +

Arguments

@@ -143,10 +144,11 @@

Arg

Character indicating the column woith the id in polyg

- +

See also

+

Examples

if (FALSE) { @@ -157,7 +159,9 @@

Examp

Contents

@@ -171,7 +175,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/adt.html b/docs/reference/adt.html index 46ce534c..29af6c1e 100644 --- a/docs/reference/adt.html +++ b/docs/reference/adt.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,13 +117,15 @@

Average daily traffic (ADT) from hourly traffic data.

+

adt calculates ADT based on hourly traffic data. The input traffic data is usually for morning rush hours.

+
adt(pc, lcv, hgv, bus, mc, p_pc, p_lcv, p_hgv, p_bus, p_mc,
   expanded = FALSE)
- +

Arguments

@@ -173,11 +174,12 @@

Arg

boolean argument for returning numeric vector or "Vehicles"

- +

Value

numeric vector of total volume of traffic per link, or data-frames of expanded traffic

+

Examples

{ @@ -216,7 +218,9 @@

Examp

Contents

@@ -230,7 +234,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/age.html b/docs/reference/age.html index 52f96546..dbdd4002 100644 --- a/docs/reference/age.html +++ b/docs/reference/age.html @@ -15,13 +15,11 @@ - - @@ -41,15 +39,15 @@ - + + - @@ -96,6 +94,7 @@ Changelog + @@ -117,12 +116,14 @@

Applies a survival rate to numeric new vehicles

+

age returns survived vehicles

+
age(x, type = "weibull", a = 14.46, b = 4.79, agemax, net,
   verbose = FALSE)
- +

Arguments

@@ -156,10 +157,11 @@

Arg regions or streets.

- +

Value

dataframe of age distrubution of vehicles

+

Note

The functions age* produce distribution of the circulating fleet by age of use. @@ -201,6 +203,7 @@

Note

Zachariadis, T., Samaras, Z., Zierock, K. H. (1995). Dynamic modeling of vehicle populations: an engineering approach for emissions calculations. Technological Forecasting and Social Change, 50(2), 135-149. Cited by Huo and Wang (2012)

+

Examples

{ @@ -241,8 +244,11 @@

Examp

Contents

@@ -256,7 +262,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/age_hdv.html b/docs/reference/age_hdv.html index f88d546d..4fe75bf4 100755 --- a/docs/reference/age_hdv.html +++ b/docs/reference/age_hdv.html @@ -15,13 +15,11 @@ - - @@ -41,15 +39,15 @@ - + + - @@ -96,6 +94,7 @@ Changelog + @@ -117,12 +116,14 @@

Returns amount of vehicles at each age

+

age_hdv returns amount of vehicles at each age

+
age_hdv(x, name = "age", a = 0.2, b = 17, agemin = 1,
   agemax = 50, k = 1, bystreet = F, net, verbose = FALSE, namerows)
- +

Arguments

@@ -172,10 +173,11 @@

Arg regions or streets.

- +

Value

dataframe of age distrubution of vehicles at each street

+

Note

The functions age* produce distribution of the circulating fleet by age of use. @@ -188,6 +190,7 @@

Note

you dont know the sales or registry of vehicles, but somehow you know the shape of this curve. 4. You can use/merge/transform/adapt any of these functions.

+

Examples

{ @@ -203,8 +206,11 @@

Examp

Contents

@@ -218,7 +224,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/age_ldv.html b/docs/reference/age_ldv.html index 27e58856..21ac1b5f 100755 --- a/docs/reference/age_ldv.html +++ b/docs/reference/age_ldv.html @@ -15,13 +15,11 @@ - - @@ -41,15 +39,15 @@ - + + - @@ -96,6 +94,7 @@ Changelog + @@ -117,12 +116,14 @@

Returns amount of vehicles at each age

+

age_ldv returns amount of vehicles at each age

+
age_ldv(x, name = "age", a = 1.698, b = -0.2, agemin = 1,
   agemax = 50, k = 1, bystreet = F, net, verbose = FALSE, namerows)
- +

Arguments

@@ -172,10 +173,11 @@

Arg regions or streets.

- +

Value

dataframe of age distrubution of vehicles

+

Note

The functions age* produce distribution of the circulating fleet by age of use. @@ -190,6 +192,7 @@

Note

4. You can use/merge/transform/adapt any of these functions.

It consists in a Gompertz equation with default parameters from 1 national emissions inventory for green housegases in Brazil, MCT 2006

+

Examples

{ @@ -205,8 +208,11 @@

Examp

Contents

@@ -220,7 +226,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/age_moto.html b/docs/reference/age_moto.html index 1f8702df..ddc0b8bc 100755 --- a/docs/reference/age_moto.html +++ b/docs/reference/age_moto.html @@ -15,13 +15,11 @@ - - @@ -41,15 +39,15 @@ - + + - @@ -96,6 +94,7 @@ Changelog + @@ -117,13 +116,15 @@

Returns amount of vehicles at each age

+

age_moto returns amount of vehicles at each age

+
age_moto(x, name = "age", a = 0.2, b = 17, agemin = 1,
   agemax = 50, k = 1, bystreet = FALSE, net, verbose = FALSE,
   namerows)
- +

Arguments

@@ -173,10 +174,11 @@

Arg regions or streets.

- +

Value

dataframe of age distrubution of vehicles

+

Note

The functions age* produce distribution of the circulating fleet by age of use. @@ -189,6 +191,7 @@

Note

you dont know the sales or registry of vehicles, but somehow you know the shape of this curve. 4. You can use/merge/transform/adapt any of these functions.

+

Examples

{ @@ -204,8 +207,11 @@

Examp

Contents

@@ -219,7 +225,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/celsius.html b/docs/reference/celsius.html index 54486e4b..3bfb032b 100644 --- a/docs/reference/celsius.html +++ b/docs/reference/celsius.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,12 +117,14 @@

Construction function for Celsius temperature

+

celsius jsut convert add unit celsius to different R objects

+
celsius(x)
- +

Arguments

@@ -132,10 +133,11 @@

Arg

Object with class "data.frame", "matrix", "numeric" or "integer"

- +

Value

Objects of class "data.frame" or "units"

+

Examples

{ @@ -169,7 +171,9 @@

Examp

Contents

@@ -183,7 +187,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/cold_mileage.html b/docs/reference/cold_mileage.html index db7aa956..578d7d05 100644 --- a/docs/reference/cold_mileage.html +++ b/docs/reference/cold_mileage.html @@ -15,13 +15,11 @@ - - @@ -41,17 +39,17 @@ - + + - @@ -98,6 +96,7 @@ Changelog + @@ -119,13 +118,15 @@

Fraction of mileage driven with a cold engine or catalizer below normal temp
+

This function depends length of trip and on ambient temperature. From the guidelines EMEP/EEA air pollutant emission inventory guidebook http://www.eea.europa.eu/themes/air/emep-eea-air-pollutant-emission-inventory-guidebook

+
cold_mileage(ltrip, ta)
- +

Arguments

@@ -139,10 +140,11 @@

Arg data.frame, it is convenient that each column is each month.

- +

Note

This function is set so that values vaires between 0 and 1.

+

Examples

{ @@ -157,7 +159,9 @@

Examp

Contents

@@ -171,7 +175,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_cetesb.html b/docs/reference/ef_cetesb.html index 9d7dd4c7..9ea444fb 100644 --- a/docs/reference/ef_cetesb.html +++ b/docs/reference/ef_cetesb.html @@ -15,13 +15,11 @@ - - @@ -41,15 +39,15 @@ - + + - @@ -96,6 +94,7 @@ Changelog + @@ -117,12 +116,14 @@

Emissions factors for Environment Company of Sao Paulo, Brazil (CETESB) 2017
+

ef_cetesb returns a vector or data.frame of Brazilian emission factors.

+
ef_cetesb(p, veh, year = 2017, agemax = 40, full = FALSE,
   project = "constant")
- +

Arguments

@@ -164,10 +165,11 @@

Arg future. Currently the only value is "constant"

- +

Value

A vector of Emission Factor or a data.frame

+

Note

This emission factors are not exactly the same as the report of CETESB.

@@ -177,10 +179,12 @@

Note

the oldest value.

3) CNG emission factors were expanded to other pollutants by comparison of US.EPA-AP42 emission factor: Section 1.4 Natural Gas Combustion.

+

References

Emissoes Veiculares no Estado de Sao Paulo 2016. Technical Report. url: https://cetesb.sp.gov.br/veicular/relatorios-e-publicacoes/.

+

Examples

{ @@ -200,9 +204,13 @@

Examp

Contents

@@ -216,7 +224,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_china.html b/docs/reference/ef_china.html index b7477554..59a6efc3 100644 --- a/docs/reference/ef_china.html +++ b/docs/reference/ef_china.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,17 +119,19 @@

Emissions factors from Chinese emissions guidelines

+

ef_china returns emission factors as vector or data.frames. The emission factors comes from the chinese emission guidelines (v3) from the Chinese Ministry of Ecology and Environment http://www.mee.gov.cn/gkml/hbb/bgth/201407/W020140708387895271474.pdf

+
ef_china(v = "PV", t = "Small", f = "G", standard, p, k = 1,
   ta = celsius(15), humidity = 0.5, altitude = 1000,
   speed = Speed(30), baseyear_det = 2016, sulphur = 50,
   load_factor = 0.5, details = FALSE, correction_only = FALSE)
- +

Arguments

@@ -208,10 +209,11 @@

Arg

Logical; When TRUE, return only correction factors.

- +

Value

An emission factor

+

Note

Combination of vehicles:

@@ -247,9 +249,11 @@

Note

+

See also

+

Examples

{ @@ -325,9 +329,13 @@

Examp

Contents

@@ -341,7 +349,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_evap.html b/docs/reference/ef_evap.html index 1d3c060a..5b45d1ff 100755 --- a/docs/reference/ef_evap.html +++ b/docs/reference/ef_evap.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,13 +117,15 @@

Evaporative emission factor

+

ef_evap is a lookup table with tier 2 evaporative emission factors from EMEP/EEA emisison guidelines

+
ef_evap(ef, v, cc, dt, ca, pollutant = "NMHC", k = 1, ltrip, kmday,
   show = FALSE, verbose = FALSE)
- +

Arguments

@@ -192,20 +193,23 @@

Arg

Logical; To show more information

- +

Value

emission factors in g/trip or g/proced. The object has class (g) but it order to know it is g/trip or g/proceed the argument show must by T

+

Note

Diurnal loses occur with daily temperature variations. Running loses occur during vehicles use. Hot soak emission occur following vehicles use.

+

References

Mellios G and Ntziachristos 2016. Gasoline evaporation. In: EEA, EMEP. EEA air pollutant emission inventory guidebook-2009. European Environment Agency, Copenhagen, 2009

+

Examples

{ @@ -360,9 +364,13 @@

Examp

Contents

@@ -376,7 +384,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_fun.html b/docs/reference/ef_fun.html index c235ed10..dbbe6749 100644 --- a/docs/reference/ef_fun.html +++ b/docs/reference/ef_fun.html @@ -15,13 +15,11 @@ - - @@ -41,15 +39,15 @@ - + + - @@ -96,6 +94,7 @@ Changelog + @@ -117,12 +116,14 @@

Experimental: Returns a function of Emission Factor by age of use

+

ef_fun returns amount of vehicles at each age

+
ef_fun(ef, type = "logistic", x = 1:length(ef), x0 = mean(ef),
   k = 1/4, L = max(ef))
- +

Arguments

@@ -151,13 +152,15 @@

Arg

Integer; the curve's maximum value.

- +

Value

dataframe of age distrubution of vehicles at each street.

+

References

https://en.wikipedia.org/wiki/Logistic_function

+

Examples

{ @@ -172,8 +175,11 @@

Examp

Contents

@@ -187,7 +193,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_hdv_scaled.html b/docs/reference/ef_hdv_scaled.html index 5fbebb1d..16d50ace 100755 --- a/docs/reference/ef_hdv_scaled.html +++ b/docs/reference/ef_hdv_scaled.html @@ -15,13 +15,11 @@ - - @@ -41,19 +39,19 @@ - + + - @@ -100,6 +98,7 @@ Changelog + @@ -121,16 +120,18 @@

Scaling constant with speed emission factors of Heavy Duty Vehicles

+

ef_hdv_scaled creates a list of scaled functions of emission factors. A scaled emission factor which at a speed of the dricing cycle (SDC) gives a desired value. This function needs a dataframe with local emission factors with a columns with the name "Euro_HDV" indicating the Euro equivalence standard, assuming that there are available local emission factors for several consecutive years.

+
ef_hdv_scaled(df, dfcol, SDC = 34.12, v, t, g, eu, gr = 0, l = 0.5,
   p)
- +

Arguments

@@ -177,14 +178,16 @@

Arg

Pollutant: "CO", "FC", "NOx" or "HC"

- +

Value

A list of scaled emission factors g/km

+

Note

The length of the list should be equal to the name of the age categories of a specific type of vehicle

+

Examples

{ @@ -206,8 +209,11 @@

Examp

Contents

@@ -221,7 +227,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_hdv_speed.html b/docs/reference/ef_hdv_speed.html index 718ffb62..d230cc67 100755 --- a/docs/reference/ef_hdv_speed.html +++ b/docs/reference/ef_hdv_speed.html @@ -15,13 +15,11 @@ - - @@ -41,17 +39,17 @@ - + + - @@ -98,6 +96,7 @@ Changelog + @@ -119,14 +118,16 @@

Emissions factors for Heavy Duty Vehicles based on average speed

+

This function returns speed dependent emission factors. The emission factors comes from the guidelines EMEP/EEA air pollutant emission inventory guidebook http://www.eea.europa.eu/themes/air/emep-eea-air-pollutant-emission-inventory-guidebook

+
ef_hdv_speed(v, t, g, eu, x, gr = 0, l = 0.5, p, k = 1,
   show.equation = FALSE, speed, fcorr = rep(1, 8))
- +

Arguments

@@ -190,10 +191,11 @@

Arg "PRE", "I", "II", "III", "IV", "V", VI, "VIc". Default is 1

- +

Value

an emission factor function which depends of the average speed V g/km

+

Note

Pollutants (g/km): "CO", "NOx", "HC", "PM", "CH4", "NMHC", "CO2", "SO2", @@ -233,9 +235,11 @@

Note

Euro V + SCR

The categories Pre Euro and Euro I were assigned with the factors of Euro II and Euro III The categories euro IV and euro V were assigned with euro III + SCR

+

See also

+

Examples

{ @@ -309,9 +313,13 @@

Examp

Contents

@@ -325,7 +333,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_im.html b/docs/reference/ef_im.html index aea2d22b..ea28ed32 100644 --- a/docs/reference/ef_im.html +++ b/docs/reference/ef_im.html @@ -15,13 +15,11 @@ - - @@ -41,19 +39,19 @@ - + + - @@ -100,6 +98,7 @@ Changelog + @@ -121,15 +120,17 @@

Emission factors deoending on accumulated mileage

+

ef_im calculate the theoretical emission factors of vehicles. The approache is different from including deterioration factors (emis_det) but similar, because they represent how much emits a vehicle with a normal deterioration, but that it will pass the Inspection and Manteinance program.

+
ef_im(ef, tc, amileage, max_amileage, max_ef, verbose = TRUE)
- +

Arguments

@@ -160,11 +161,12 @@

Arg

Logical; if you want detailed description.

- +

Value

An emission factor of a deteriorated vehicle under normal conditions which would be approved in a inspection and mantainence program.

+

Examples

{ @@ -182,7 +184,9 @@

Examp

Contents

@@ -196,7 +200,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_ive.html b/docs/reference/ef_ive.html index 7427834c..030b349d 100644 --- a/docs/reference/ef_ive.html +++ b/docs/reference/ef_ive.html @@ -15,13 +15,11 @@ - - @@ -41,17 +39,17 @@ - + + - @@ -98,6 +96,7 @@ Changelog + @@ -119,16 +118,18 @@

Base emissions factors from International Vehicle Emissions (IVE) model

+

ef_ive returns the base emission factors from the the IVE model. This function depend on vectorized mileage, which means your can enter with the mileage by age of use and the name of the pollutant.

+
ef_ive(description = "Auto/Sml Truck", fuel = "Petrol",
   weight = "Light", air_fuel_control = "Carburetor",
   exhaust = "None", evaporative = "PCV", mileage, pol,
   details = FALSE)
- +

Arguments

@@ -190,16 +191,18 @@

Arg

Logical; option to see or not more information about vehicle.

- +

Value

An emission factor by annual mileage.

+

References

Nicole Davis, James Lents, Mauricio Osses, Nick Nikkila, Matthew Barth. 2005. Development and Application of an International Vehicle Emissions Model. Transportation Research Board, 81st Annual Meeting, January 2005, Washington, D.C.

+

Examples

{ @@ -221,8 +224,11 @@

Examp

Contents

@@ -236,7 +242,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_ldv_cold.html b/docs/reference/ef_ldv_cold.html index be670979..c5e2b04f 100755 --- a/docs/reference/ef_ldv_cold.html +++ b/docs/reference/ef_ldv_cold.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,15 +119,17 @@

Cold-Start Emissions factors for Light Duty Vehicles

+

ef_ldv_cold returns speed functions or data.frames which depends on ambient temperature average speed. The emission factors comes from the guidelines EMEP/EEA air pollutant emission inventory guidebook http://www.eea.europa.eu/themes/air/emep-eea-air-pollutant-emission-inventory-guidebook

+
ef_ldv_cold(v = "LDV", ta, cc, f, eu, p, k = 1,
   show.equation = FALSE, speed, fcorr = rep(1, 8))
- +

Arguments

@@ -182,14 +183,16 @@

Arg "PRE", "I", "II", "III", "IV", "V", VI, "VIc". Default is 1

- +

Value

an emission factor function which depends of the average speed V and ambient temperature. g/km

+

See also

+

Examples

{ @@ -242,8 +245,11 @@

Examp

Contents

@@ -257,7 +263,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_ldv_cold_list.html b/docs/reference/ef_ldv_cold_list.html index edf44402..8f38efc7 100755 --- a/docs/reference/ef_ldv_cold_list.html +++ b/docs/reference/ef_ldv_cold_list.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,12 +117,14 @@

List of cold start emission factors of Light Duty Vehicles

+

This function creates a list of functions of cold start emission factors considering different euro emission standard to the elements of the list.

+
ef_ldv_cold_list(df, v = "LDV", ta, cc, f, eu, p)
- +

Arguments

@@ -157,14 +158,16 @@

Arg

Pollutant: "CO", "FC", "NOx", "HC" or "PM"

- +

Value

A list of cold start emission factors g/km

+

Note

The length of the list should be equal to the name of the age categories of a specific type of vehicle

+

Examples

{ @@ -182,8 +185,11 @@

Examp

Contents

@@ -197,7 +203,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_ldv_scaled.html b/docs/reference/ef_ldv_scaled.html index 74f615af..bdcdcbce 100755 --- a/docs/reference/ef_ldv_scaled.html +++ b/docs/reference/ef_ldv_scaled.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,12 +117,14 @@

Scaling constant with speed emission factors of Light Duty Vehicles

+

This function creates a list of scaled functions of emission factors. A scaled emission factor which at a speed of the driving cycle (SDC) gives a desired value.

+
ef_ldv_scaled(df, dfcol, SDC = 34.12, v, t = "4S", cc, f, eu, p)
- +

Arguments

@@ -169,23 +170,27 @@

Arg is based on fuel, use "FC", if it is based on "HC", use "HC".

- +

Value

A list of scaled emission factors g/km

+

Details

This function calls "ef_ldv_speed" and calculate the specific k value, dividing the local emission factor by the respective speed emissions factor at the speed representative of the local emission factor, e.g. If the local emission factors were tested with the FTP-75 test procedure, SDC = 34.12 km/h.

+

Note

The length of the list should be equal to the name of the age categories of a specific type of vehicle. Thanks to Glauber Camponogara for the help.

+

See also

ef_ldv_seed

+

Examples

{ @@ -208,10 +213,15 @@

Examp

Contents

@@ -225,7 +235,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_ldv_speed.html b/docs/reference/ef_ldv_speed.html index 6362c019..f2743092 100755 --- a/docs/reference/ef_ldv_speed.html +++ b/docs/reference/ef_ldv_speed.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,15 +119,17 @@

Emissions factors for Light Duty Vehicles and Motorcycles

+

ef_ldv_speed returns speed dependent emission factors, data.frames or list of emission factors. The emission factors comes from the guidelines EMEP/EEA air pollutant emission inventory guidebook http://www.eea.europa.eu/themes/air/emep-eea-air-pollutant-emission-inventory-guidebook

+
ef_ldv_speed(v, t = "4S", cc, f, eu, p, x, k = 1, speed,
   show.equation = FALSE, fcorr = rep(1, 8))
- +

Arguments

@@ -191,16 +192,18 @@

Arg "PRE", "I", "II", "III", "IV", "V", VI, "VIc". Default is 1

- +

Value

An emission factor function which depends of the average speed V g/km

+

Details

The argument of this functions have several options which results in different combinations that returns emission factors. If a combination of any option is wrong it will return an empty value. Therefore, it is important ti know the combinations.

+

Note

t = "ALL" and cc == "ALL" works for several pollutants because emission @@ -246,9 +249,11 @@

Note

The available standards for Active Surface or number of particles are Euro I, II, III, III+DPF dor diesle and III+DISI for gasoline. Pre euro vehicles has the value of Euro I and euro IV, V, VI and VIc the value of euro III.

+

See also

+

Examples

{ @@ -371,10 +376,15 @@

Examp

Contents

@@ -388,7 +398,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_nitro.html b/docs/reference/ef_nitro.html index c4ddba00..1e64a2e1 100755 --- a/docs/reference/ef_nitro.html +++ b/docs/reference/ef_nitro.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,16 +119,18 @@

Emissions factors of N2O and NH3

+

ef_nitro returns emission factors as a functions of acondumulated mileage. The emission factors comes from the guidelines EMEP/EEA air pollutant emission inventory guidebook http://www.eea.europa.eu/themes/air/emep-eea-air-pollutant-emission-inventory-guidebook

+
ef_nitro(v, t = "Hot", cond = "Urban", cc, f, eu, p = "NH3",
   S = 10, cumileage, k = 1, show.equation = FALSE, fcorr = rep(1,
   8))
- +

Arguments

@@ -186,15 +187,17 @@

Arg

Numeric; Correction by by euro technology.

- +

Value

an emission factor function which depends on the acondumulated mileage, or an EmissionFactor

+

Note

if length of eu is bigger than 1, cumileage can have values of length 1 or length equal to length of eu

+

Examples

{ @@ -215,8 +218,11 @@

Examp

Contents

@@ -230,7 +236,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_wear.html b/docs/reference/ef_wear.html index 6354671a..81d0d288 100755 --- a/docs/reference/ef_wear.html +++ b/docs/reference/ef_wear.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,12 +117,14 @@

Emissions factors from tyre, break and road surface wear

+

ef_wear estimates wear emissions. The sources are tyres, breaks and road surface.

+
ef_wear(wear, type, pol = "TSP", speed, load = 0.5, axle = 2)
- +

Arguments

@@ -152,15 +153,17 @@

Arg

Number of axle of the HDV

- +

Value

emission factors grams/km

+

References

Ntziachristos and Boulter 2016. Automobile tyre and break wear and road abrasion. In: EEA, EMEP. EEA air pollutant emission inventory guidebook-2009. European Environment Agency, Copenhagen, 2016

+

Examples

if (FALSE) { @@ -175,8 +178,11 @@

Examp

Contents

@@ -190,7 +196,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/ef_whe.html b/docs/reference/ef_whe.html index e3c9cd8a..3b8165ea 100644 --- a/docs/reference/ef_whe.html +++ b/docs/reference/ef_whe.html @@ -15,13 +15,11 @@ - - @@ -41,20 +39,20 @@ - + + - @@ -101,6 +99,7 @@ Changelog + @@ -122,16 +121,18 @@

Emission factor that incorporates the effect of high emitters

+

ef_whe return weighted emission factors of vehicles considering that one part of the fleet has a normal deterioration and another has a deteriorated fleet that would be rejected in a inspection and mantainence program but it is still in circulation. This emission factor might be applicable in cities without a inspection and mantainence program and with Weighted emission factors considering that part of the fleet are high emitters.

+
ef_whe(efhe, phe, ef)
- +

Arguments

@@ -151,10 +152,11 @@

Arg program.

- +

Value

An emission factor by annual mileage.

+

Examples

{ @@ -171,13 +173,15 @@

Examp plot(co_efhe) lines(co_ef_normal, pch = 16, col = "red" ) lines(efd, pch = 16, col = "blue") -}

#> Warning: longer object length is not a multiple of shorter object length
#> Warning: longer object length is not a multiple of shorter object length
+}
#> Warning: comprimento do objeto maior não é múltiplo do comprimento do objeto menor
#> Warning: comprimento do objeto maior não é múltiplo do comprimento do objeto menor
-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis.html b/docs/reference/emis.html index 154a2694..8222ba5a 100755 --- a/docs/reference/emis.html +++ b/docs/reference/emis.html @@ -15,13 +15,11 @@ - - @@ -41,17 +39,17 @@ - + + - @@ -98,6 +96,7 @@ Changelog + @@ -119,15 +118,17 @@

Estimation of emissions

+

emis estimates vehicular emissions as the product of the vehicles on a road, length of the road, emission factor avaliated at the respective speed. \(E = VEH*LENGTH*EF(speed)\)

+
emis(veh, lkm, ef, speed = 34, agemax = ifelse(is.data.frame(veh),
   ncol(veh), ncol(veh[[1]])), profile, hour = nrow(profile),
   day = ncol(profile), array = T, verbose = FALSE)
- +

Arguments

@@ -177,16 +178,18 @@

Arg

Logical; To show more information

- +

Value

If the user applies a top-down approach, the resulting units will be according its own data. For instance, if the vehicles are veh/day, the units of the emissions implicitly will be g/day.

+

Note

Hour and day will be deprecated because they can be infered from the profile matrix.

+

Examples

if (FALSE) { @@ -279,8 +282,11 @@

Examp

Contents

@@ -294,7 +300,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_chem.html b/docs/reference/emis_chem.html index 67bd9534..b33e7b66 100644 --- a/docs/reference/emis_chem.html +++ b/docs/reference/emis_chem.html @@ -15,13 +15,11 @@ - - @@ -41,17 +39,17 @@ - + + - @@ -98,6 +96,7 @@ Changelog + @@ -119,13 +118,15 @@

Aggregate emissions by lumped groups in chemical mechanism

+

emis_chem aggregates emissions by chemical mechanism and convert grams to mol. This function reads all hydrocarbos and respective criteria polluants specified in ef_ldv_speed and ef_hdv_speed.

+
emis_chem(dfe, mechanism, colby, long = FALSE)
- +

Arguments

@@ -148,11 +149,12 @@

Arg

Logical. Do you want data in long format?

- +

Value

data.frame with lumped groups by chemical mechanism. It transform emissions in grams to mol.

+

Note

This feature is experimental and the mapping of pollutants and lumped @@ -165,9 +167,11 @@

Note

units for WRF-Chem are ug/m^2/s while for CMAQ and CAMx are g/s. So, leaving the units just in g, allow to make further change while providing flexibility for several models.

+

See also

+

Examples

{ @@ -235,9 +239,13 @@

Examp

Contents

@@ -251,7 +259,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_cold.html b/docs/reference/emis_cold.html index d398787b..67b31638 100755 --- a/docs/reference/emis_cold.html +++ b/docs/reference/emis_cold.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,17 +119,19 @@

Estimation of cold start emissions hourly for the of the week

+

emis_cold emissions are estimated as the product of the vehicles on a road, length of the road, emission factor avaliated at the respective speed.The estimation considers beta parameter, the fraction of mileage driven

+
emis_cold(veh, lkm, ef, efcold, beta, speed = 34, agemax = if
   (!inherits(x = veh, what = "list")) {     ncol(veh) } else {
   ncol(veh[[1]]) }, profile, hour = nrow(profile), day = ncol(profile),
   array = TRUE, verbose = FALSE)
- +

Arguments

@@ -189,10 +190,11 @@

Arg

Logical; To show more information

- +

Value

EmissionsArray g/h

+

Examples

if (FALSE) { @@ -245,7 +247,9 @@

Examp

Contents

@@ -259,7 +263,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_cold_td.html b/docs/reference/emis_cold_td.html index a79f673d..77b2b67a 100644 --- a/docs/reference/emis_cold_td.html +++ b/docs/reference/emis_cold_td.html @@ -15,13 +15,11 @@ - - @@ -41,8 +39,8 @@ - + + - @@ -103,6 +101,7 @@ Changelog + @@ -124,6 +123,7 @@

Estimation of cold start emissions with top-down approach

+

emis_cold_td estimates cld start emissions with a top-down appraoch. This is, annual or monthly emissions or region. Especifically, the emissions are esitmated for row of the simple feature (row @@ -132,11 +132,12 @@

Estimation of cold start emissions with top-down approach

different average monthly temperature. This funcion, as other in this package, adapts to the class of the input data. providing flexibility to the user.

+
emis_cold_td(veh, lkm, ef, efcold, beta, pro_month, params,
   verbose = FALSE)
- +

Arguments

@@ -179,13 +180,15 @@

Arg

Logical; To show more information

- +

Value

Emissions data.frame

+

See also

+

Examples

if (FALSE) { @@ -217,8 +220,11 @@

Examp

Contents

@@ -232,7 +238,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_det.html b/docs/reference/emis_det.html index 23957736..c9a520d3 100755 --- a/docs/reference/emis_det.html +++ b/docs/reference/emis_det.html @@ -15,13 +15,11 @@ - - @@ -41,19 +39,19 @@ - + + - @@ -100,6 +98,7 @@ Changelog + @@ -121,16 +120,18 @@

Determine deterioration factors for urban conditions

+

emis_det returns deterioration factors. The emission factors comes from the guidelines for developing emission factors of the EMEP/EEA air pollutant emission inventory guidebook http://www.eea.europa.eu/themes/air/emep-eea-air-pollutant-emission-inventory-guidebook This function subset an internal database of emission factors with each argument

+
emis_det(po, cc, eu, speed = Speed(18.9), km, verbose = FALSE,
   show.equation = FALSE)
- +

Arguments

@@ -164,10 +165,11 @@

Arg

Option to see or not the equation parameters

- +

Value

It returns a numeric vector representing the increase in emissions due to normal deterioring

+

Note

The deterioration factors functions are available for technologies @@ -175,6 +177,7 @@

Note

function assumes that the deterioration function of "III" and "IV" applies for "V", "VI" and "VIc". However, as these technologies are relative new, accumulated milage is low and hence, deteerioration factors small.

+

Examples

{ @@ -220,8 +223,11 @@

Examp

Contents

@@ -235,7 +241,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_dist.html b/docs/reference/emis_dist.html index 17bc57d9..63cac2d5 100644 --- a/docs/reference/emis_dist.html +++ b/docs/reference/emis_dist.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,14 +119,16 @@

Allocate emissions into spatial objects (street emis to grid)

+

emis_dist allocates emissions proportionally to each feature. "Spatial" objects are converter to "sf" objects. Currently, 'LINESTRING' or 'MULTILINESTRING' supported. The emissions are distributed in each street.

+
emis_dist(gy, spobj, pro, osm, verbose = TRUE)
- +

Arguments

@@ -158,11 +159,12 @@

Arg

Logical; to show more info.

- +

Note

When spobj is a 'Spatial' object (class of sp), they are converted into 'sf'.

+

Examples

{ @@ -181,7 +183,9 @@

Examp

Contents

@@ -195,7 +199,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_evap.html b/docs/reference/emis_evap.html index 669b9732..0dea018b 100755 --- a/docs/reference/emis_evap.html +++ b/docs/reference/emis_evap.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,13 +117,15 @@

Estimation of evaporative emissions

+

emis_evap estimates evaporative emissions from EMEP/EEA emisison guidelines

+
emis_evap(veh, x, ed, hotfi, hotc, warmc, carb = 0, p, params, pro_month,
   verbose = FALSE)
- +

Arguments

@@ -188,23 +189,27 @@

Arg

Logical; To show more information

- +

Value

numeric vector of emission estimation in grams

+

Note

When veh is a "Vehicles" data.frame, emission factors are evaluated till the number of columns of veh. For instance, if the length of the emision factor is 20 but the number of columns of veh is 10, the 10 first emission factors are used.

+

References

Mellios G and Ntziachristos 2016. Gasoline evaporation. In: EEA, EMEP. EEA air pollutant emission inventory guidebook-2009. European Environment Agency, Copenhagen, 2009

+

See also

+

Examples

{ @@ -219,10 +224,15 @@

Examp

Contents

@@ -236,7 +246,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_evap2.html b/docs/reference/emis_evap2.html index 86163128..79c7f39f 100644 --- a/docs/reference/emis_evap2.html +++ b/docs/reference/emis_evap2.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,14 +117,16 @@

Estimation of evaporative emissions 2

+

emis_evap performs the estimation of evaporative emissions from EMEP/EEA emisison guidelines with Tier 2.

+
emis_evap2(veh, name, size, fuel, aged, nd4, nd3, nd2, nd1, hs_nd4, hs_nd3,
   hs_nd2, hs_nd1, rl_nd4, rl_nd3, rl_nd2, rl_nd1, d_nd4, d_nd3, d_nd2,
   d_nd1)
- +

Arguments

@@ -229,15 +230,17 @@

Arg temperature between -5 and 10 celcius degrees

- +

Value

dataframe of emission estimation in grams/days

+

References

Mellios G and Ntziachristos 2016. Gasoline evaporation. In: EEA, EMEP. EEA air pollutant emission inventory guidebook-2009. European Environment Agency, Copenhagen, 2009

+

Examples

{ @@ -299,8 +302,11 @@

Examp

Contents

@@ -314,7 +320,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_grid.html b/docs/reference/emis_grid.html index 0c7a9a70..09c2acec 100755 --- a/docs/reference/emis_grid.html +++ b/docs/reference/emis_grid.html @@ -15,13 +15,11 @@ - - @@ -41,19 +39,19 @@ - + + - @@ -100,6 +98,7 @@ Changelog + @@ -121,15 +120,17 @@

Allocate emissions into a grid

+

emis_grid allocates emissions proportionally to each grid cell. The process is performed by intersection between geometries and the grid. It means that requires "sr" according with your location for the projection. It is assumed that spobj is a Spatial*DataFrame or an "sf" with the pollutants in data. This function returns an object of class "sf".

+
emis_grid(spobj = net, g, sr, type = "lines", FN = "sum")
- +

Arguments

@@ -156,11 +157,12 @@

Arg

Character indicating the function. Default is "sum"

- +

Note

When spobj is a 'Spatial' object (class of sp), they are converted into 'sf'. Also, The aggregation of data is done with data.table functions.

+

Examples

{ @@ -186,7 +188,9 @@

Examp

Contents

@@ -200,7 +204,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_hot_td.html b/docs/reference/emis_hot_td.html index 50057842..871f7c1e 100644 --- a/docs/reference/emis_hot_td.html +++ b/docs/reference/emis_hot_td.html @@ -15,13 +15,11 @@ - - @@ -41,8 +39,8 @@ - + + - @@ -103,6 +101,7 @@ Changelog + @@ -124,6 +123,7 @@

Estimation of hot exhaust emissions with top-down approach

+

emis_hot_td estimates cld start emissions with a top-down appraoch. This is, annual or monthly emissions or region. Especifically, the emissions are esitmated for row of the simple feature (row @@ -132,10 +132,11 @@

Estimation of hot exhaust emissions with top-down approach

different average monthly temperature. This funcion, as other in this package, adapts to the class of the input data. providing flexibility to the user.

+
emis_hot_td(veh, lkm, ef, pro_month, params, verbose = FALSE)
- +

Arguments

@@ -172,13 +173,15 @@

Arg

Logical; To show more information

- +

Value

Emissions data.frame

+

See also

+

Examples

{ @@ -226,8 +229,11 @@

Examp

Contents

@@ -241,7 +247,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_merge.html b/docs/reference/emis_merge.html index 387834be..001bc20f 100644 --- a/docs/reference/emis_merge.html +++ b/docs/reference/emis_merge.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,14 +117,16 @@

Merge several emissions files returning data-frames or 'sf' of lines

+

emis_merge reads rds files and returns a data-frame or an object of 'spatial feature' of streets, merging several files.

+
emis_merge(pol = "CO", what = "STREETS.rds", streets = T, net,
   path = "emi", crs, under = "after", ignore = FALSE,
   as_list = FALSE)
- +

Arguments

@@ -175,10 +176,11 @@

Arg

"Logical"; for returning the results as list or not.

- +

Value

'Spatial feature' of lines or a dataframe of emissions

+

Examples

if (FALSE) { @@ -190,7 +192,9 @@

Examp

Contents

@@ -204,7 +208,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_order.html b/docs/reference/emis_order.html index 8cf06e96..b088df33 100644 --- a/docs/reference/emis_order.html +++ b/docs/reference/emis_order.html @@ -15,13 +15,11 @@ - - @@ -41,19 +39,19 @@ - + + - @@ -100,6 +98,7 @@ Changelog + @@ -121,15 +120,17 @@

Re-order the emission to match specific hours and days

+

returns the emission array matching with corresponding weekdays and with the desired number of hours, recycling or droping hours from the emission array. For instance, if your emissions starts Monday at 00:00 and cover 168 hours, and you want to reorder them to start saturday you with a total a new length of hours of 241, you must :emis_order(EMISSION, as.Date("2016-04-06"), 241)

+
emis_order(EMISSION, start = "mon", hours = 168, utc, verbose = TRUE)
- +

Arguments

@@ -160,14 +161,16 @@

Arg

Logical; display additional information

- +

Format

Emissions

+

Value

GriddedEmissionsArray, sf or data.frame, depending on the class of EMISSION

+

Note

This function assumes that the emissions have hours with length of @@ -176,6 +179,7 @@

Note

instance, if the input covers 168 hours and it is desired an object of 241 hours that start saturday, this function can do that. It is useful when you are going to start a air quality simulation for specific periods of time.

+

Examples

if (FALSE) { @@ -187,9 +191,13 @@

Examp

Contents

@@ -205,7 +213,7 @@

Author

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_paved.html b/docs/reference/emis_paved.html index 7af30048..1619159c 100755 --- a/docs/reference/emis_paved.html +++ b/docs/reference/emis_paved.html @@ -15,13 +15,11 @@ - - @@ -41,19 +39,19 @@ - + + - @@ -100,6 +98,7 @@ Changelog + @@ -121,16 +120,18 @@

Estimation of resuspension emissions from paved roads

+

emis_paved estimates vehicular emissions from paved roads. The vehicular emissions are estimated as the product of the vehicles on a road, length of the road, emission factor from AP42 13.2.1 Paved roads. It is assumed dry hours and anual aggregation should consider moisture factor. It depends on Average Daily Traffic (ADT)

+
emis_paved(veh, lkm, k = 0.62, sL1 = 0.6, sL2 = 0.2, sL3 = 0.06,
   sL4 = 0.03, W)
- +

Arguments

@@ -170,14 +171,16 @@

Arg weight of traffic fleet in each road

- +

Value

emission estimation g/h

+

References

EPA, 2016. Emission factor documentation for AP-42. Section 13.2.1, Paved Roads. https://www3.epa.gov/ttn/chief/ap42/ch13/final/c13s0201.pdf

+

Examples

{ @@ -199,8 +202,11 @@

Examp

Contents

@@ -214,7 +220,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_post.html b/docs/reference/emis_post.html index 7b25782c..72479b17 100755 --- a/docs/reference/emis_post.html +++ b/docs/reference/emis_post.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,14 +119,16 @@

Post emissions

+

emis_post simplify emissions estimated as total per type category of vehicle or by street. It reads EmissionsArray. It can return an dataframe with hourly emissions at each street, or a data base with emissions by vehicular category, hour, including size, fuel and other characteristics.

+
emis_post(arra, veh, size, fuel, pollutant, by = "veh", net)
- +

Arguments

@@ -166,7 +167,7 @@

Arg when by = 'streets_wide'

- +

Note

This function depends on EmissionsArray objests which currently has @@ -175,6 +176,7 @@

Note

made in order to not produce inconsistencies with previous versions, therefore, if the user count with an EmissionsArry with 4 dimension, it will be able to use this function.

+

Examples

if (FALSE) { @@ -243,7 +245,9 @@

Examp

Contents

@@ -257,7 +261,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_source.html b/docs/reference/emis_source.html index 6915e687..85ac5c43 100644 --- a/docs/reference/emis_source.html +++ b/docs/reference/emis_source.html @@ -15,13 +15,11 @@ - - @@ -41,15 +39,15 @@ - + + - @@ -96,6 +94,7 @@ Changelog + @@ -117,12 +116,14 @@

A function to source vein scripts

+

emis_source source vein scripts

+
emis_source(path = "est", pattern = ".R", ignore = "~", first,
   ask = TRUE, recursive = TRUE, full.names = TRUE)
- +

Arguments

@@ -158,7 +159,7 @@

Arg

Logical; full.names or not. Default is "TRUE".

- +

Examples

if (FALSE) { @@ -169,6 +170,7 @@

Examp

Contents

@@ -182,7 +184,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_to_streets.html b/docs/reference/emis_to_streets.html index b3330bd7..27fd7219 100644 --- a/docs/reference/emis_to_streets.html +++ b/docs/reference/emis_to_streets.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,14 +119,16 @@

Emis to streets distribute top-down emissions into streets

+

emis_to_streets allocates emissions proportionally to each feature. "Spatial" objects are converter to "sf" objects. Currently, 'LINESTRING' or 'MULTILINESTRING' supported. The emissions are distributed in each street.

+
emis_to_streets(streets, dfemis, by = "ID", stpro, verbose = TRUE)
- +

Arguments

@@ -158,14 +159,16 @@

Arg

Logical; to show more info.

- +

Note

When spobj is a 'Spatial' object (class of sp), they are converted into 'sf'.

+

See also

+

Examples

{ @@ -192,8 +195,11 @@

Examp

Contents

@@ -207,7 +213,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_wear.html b/docs/reference/emis_wear.html index 4d511d69..db5eed52 100755 --- a/docs/reference/emis_wear.html +++ b/docs/reference/emis_wear.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,13 +117,15 @@

Emission estimation from tyre, break and road surface wear

+

emis_wear estimates wear emissions. The sources are tyres, breaks and road surface.

+
emis_wear(veh, lkm, ef, what = "tyre", speed, agemax = ncol(veh),
   profile, hour = nrow(profile), day = ncol(profile))
- +

Arguments

@@ -167,15 +168,17 @@

Arg

Number of considered days in estimation

- +

Value

emission estimation g/h

+

References

Ntziachristos and Boulter 2016. Automobile tyre and break wear and road abrasion. In: EEA, EMEP. EEA air pollutant emission inventory guidebook-2009. European Environment Agency, Copenhagen, 2016

+

Examples

{ @@ -201,8 +204,11 @@

Examp

Contents

@@ -216,7 +222,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/emis_wrf-deprecated.html b/docs/reference/emis_wrf-deprecated.html index a797950b..468dd678 100644 --- a/docs/reference/emis_wrf-deprecated.html +++ b/docs/reference/emis_wrf-deprecated.html @@ -15,13 +15,11 @@ - - @@ -41,17 +39,17 @@ - + + - @@ -98,6 +96,7 @@ Changelog + @@ -119,12 +118,14 @@

Generates emissions dataframe to generate WRF-Chem inputs

+

emis_wrf returns a dataframes with columns lat, long, id, pollutants, local time and GMT time. This dataframe has the proper format to be used with WRF assimilation system: "ASimilation System 4 WRF (AS4WRF Vera-Vala et al (2016))

+
- +

Arguments

@@ -162,18 +163,20 @@

Arg

logical value to indicate if sdf is a list or not

- +

See also

+ @@ -185,7 +188,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/fe2015.html b/docs/reference/fe2015.html index 3c015b18..e133f829 100755 --- a/docs/reference/fe2015.html +++ b/docs/reference/fe2015.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,13 +117,14 @@

Emission factors from Environmental Agency of Sao Paulo CETESB

+

A dataset containing emission factors from CETESB and its equivalency with EURO

+
data(fe2015)
- - +

Format

A data frame with 288 rows and 12 variables:

@@ -146,17 +146,21 @@

FormatLT

CETESB emission standard for Light Trucks with Diesel (g/km)

+

Source

https://cetesb.sp.gov.br/

+ @@ -168,7 +172,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/fkm.html b/docs/reference/fkm.html index ff70a2b0..08bf3df0 100755 --- a/docs/reference/fkm.html +++ b/docs/reference/fkm.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,15 +119,16 @@

List of functions of mileage in km fro Brazilian fleet

+

Functions from CETESB: Antonio de Castro Bruni and Marcelo Pereira Bales. 2013. Curvas de intensidade de uso por tipo de veiculo automotor da frota da cidade de Sao Paulo This functions depends on the age of use of the vehicle

+
data(fkm)
- - +

Format

A data frame with 288 rows and 12 variables:

@@ -147,17 +147,21 @@

FormatKM_LDV_GNV

Mileage in km of Light Duty Vehicles using Natural Gas

+

Source

https://cetesb.sp.gov.br/

+ @@ -169,7 +173,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/fuel_corr.html b/docs/reference/fuel_corr.html index a3f7b897..9cf09040 100644 --- a/docs/reference/fuel_corr.html +++ b/docs/reference/fuel_corr.html @@ -15,13 +15,11 @@ - - @@ -41,17 +39,17 @@ - + + - @@ -98,6 +96,7 @@ Changelog + @@ -119,14 +118,16 @@

Correction due Fuel effects

+

Take into account the effect of better fuels on vehicles with older technology. If the ratio is less than 1, return 1. It means that it is nota degradation function.

+
fuel_corr(euro, g = c(e100 = 52, aro = 39, o2 = 0.4, e150 = 86, olefin =
   10, s = 165), d = c(den = 840, pah = 9, cn = 51, t95 = 350, s = 400))
- +

Arguments

@@ -148,10 +149,11 @@

Arg (Back end distillation in Celcius degrees) and s (sulphur, ppm)

- +

Value

A list with the correction of emission factors.

+

Note

This function cannot be used to account for deterioration, therefore, @@ -169,6 +171,7 @@

Note

PAH = Aromatics content in

CN = Cetane number

T95 = Back-end distillation in o C.

+

Examples

{ @@ -180,8 +183,11 @@

Examp

Contents

@@ -195,7 +201,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/grid_emis.html b/docs/reference/grid_emis.html index eb40b1bc..e286e2e4 100644 --- a/docs/reference/grid_emis.html +++ b/docs/reference/grid_emis.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,14 +119,16 @@

Allocate emissions gridded emissions into streets (grid to emis street)

+

grid_emis it is sort of the opposite of emis_grid. It allocates gridded emissions into streets. This function applies emis_dist into each grid cell using lapply. This function is in development and pull request are welcome.

+
grid_emis(spobj, g, sr, pro, osm, verbose = TRUE)
- +

Arguments

@@ -167,11 +168,12 @@

Arg

Logical; to show more info.

- +

Note

When spobj is a 'Spatial' object (class of sp), they are converted into 'sf'.

+

Examples

{ @@ -198,9 +200,9 @@

Examp #do not run library(osmdata) library(sf) -osm <- osmdata_sf( -add_osm_feature( -opq(bbox = st_bbox(gCO)), +osm <- osmdata_sf( +add_osm_feature( +opq(bbox = st_bbox(gCO)), key = 'highway'))$osm_lines[, c("highway")] st <- c("motorway", "motorway_link", "trunk", "trunk_link", "primary", "primary_link", "secondary", "secondary_link", @@ -220,7 +222,9 @@

Examp

Contents

@@ -234,7 +238,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/index.html b/docs/reference/index.html index f4c53ed0..3aacd276 100755 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -15,13 +15,11 @@ - - @@ -41,14 +39,13 @@ - + - @@ -95,6 +92,7 @@ Changelog + @@ -574,7 +572,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/invcop.html b/docs/reference/invcop.html index 126f84ba..8e0e8dcb 100644 --- a/docs/reference/invcop.html +++ b/docs/reference/invcop.html @@ -15,13 +15,11 @@ - - @@ -41,15 +39,15 @@ - + + - @@ -96,6 +94,7 @@ Changelog + @@ -117,13 +116,15 @@

Helper function to copy and zip projects

+

invcop help to copy and zip projects

+
invcop(in_name = getwd(), out_name, all = FALSE, main = TRUE,
   ef = TRUE, est = TRUE, network = TRUE, veh_rds = FALSE,
   veh_csv = TRUE, zip = TRUE)
- +

Arguments

@@ -168,13 +169,15 @@

Arg

Logical; zip or not.

- +

Value

emission estimation g/h

+

Note

This function was created to copy and zip project without the emis.

+

Examples

if (FALSE) { @@ -185,8 +188,11 @@

Examp

Contents

@@ -200,7 +206,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/inventory.html b/docs/reference/inventory.html index bb9568c1..cf634868 100644 --- a/docs/reference/inventory.html +++ b/docs/reference/inventory.html @@ -15,13 +15,11 @@ - - @@ -41,17 +39,17 @@ - + + - @@ -98,6 +96,7 @@ Changelog + @@ -119,15 +118,17 @@

Inventory function.

+

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

+
inventory(name, vehcomp = c(PC = 1, LCV = 1, HGV = 1, BUS = 1, MC = 1),
   show.main = TRUE, scripts = TRUE, show.dir = TRUE,
   show.scripts = FALSE, clear = TRUE, rush.hour = FALSE)
- +

Arguments

@@ -170,7 +171,7 @@

Arg

Logical, to create a template for morning rush hour.

- +

Value

Structure of directories and scripts for automating compilation of @@ -205,6 +206,7 @@

Value

estimation of emissions of each category. Also, there is a file called traffic.R to generates objects of class "Vehicles". The user can rename these scripts.

+

Examples

if (FALSE) { @@ -217,7 +219,9 @@

Examp

Contents

@@ -231,7 +235,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/long_to_wide.html b/docs/reference/long_to_wide.html index e6b8859b..99b883bd 100644 --- a/docs/reference/long_to_wide.html +++ b/docs/reference/long_to_wide.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,13 +117,15 @@

Transform data.frame from long to wide format

+

long_to_wide transform data.frame from long to wide format

+
long_to_wide(df, column_with_new_names = names(df)[1],
   column_with_data = "emission", column_fixed, geometry)
- +

Arguments

@@ -149,13 +150,15 @@

Arg

To return a sf

- +

Value

wide data.frame.

+

See also

+

Examples

{ @@ -181,8 +184,11 @@

Examp

Contents

@@ -196,7 +202,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/make_grid.html b/docs/reference/make_grid.html index 8e2e0cc9..90ba2156 100755 --- a/docs/reference/make_grid.html +++ b/docs/reference/make_grid.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,12 +117,14 @@

Creates rectangular grid for emission allocation

+

make_grid creates a sf grid of polygons. The spatial reference is taken from the spatial object.

+
make_grid(spobj, width, height = width, polygon, crs = 4326, ...)
- +

Arguments

@@ -157,10 +158,11 @@

Arg

ignored

- +

Value

A grid of polygons class 'sf'

+

Examples

{ @@ -182,7 +184,9 @@

Examp

Contents

@@ -196,7 +200,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/matvect.html b/docs/reference/matvect.html index 92301870..61e5a8dd 100644 --- a/docs/reference/matvect.html +++ b/docs/reference/matvect.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,12 +117,14 @@

Matrix and vector multiplication

+

matvect it is a helper function to multiply matrices with vector by rows or columns

+
matvect(df, x, by = "row")
- +

Arguments

@@ -140,10 +141,11 @@

Arg

Character, with two value "row" or "col"

- +

Value

data-frame

+

Note

This function multiplies matrices with vectors by rows or colums. @@ -151,6 +153,7 @@

Note

of the vector x. If by = "col" all values of each column will be multiplied with each value of the vector x.

+

Examples

if (FALSE) { @@ -164,8 +167,11 @@

Examp

Contents

@@ -179,7 +185,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/my_age.html b/docs/reference/my_age.html index c97ba1a3..c4513323 100755 --- a/docs/reference/my_age.html +++ b/docs/reference/my_age.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,13 +117,15 @@

Returns amount of vehicles at each age

+

my_age returns amount of vehicles at each age using a numeric vector.

+
my_age(x, y, agemax, name = "vehicle", k = 1, pro_street, net,
   verbose = FALSE, namerows)
- +

Arguments

@@ -173,10 +174,11 @@

Arg regions or streets.

- +

Value

dataframe of age distrubution of vehicles.

+

Note

The functions age* produce distribution of the circulating fleet by age of use. @@ -189,6 +191,7 @@

Note

you dont know the sales or registry of vehicles, but somehow you know the shape of this curve. 4. You can use/merge/transform/adapt any of these functions.

+

Examples

{ @@ -220,8 +223,11 @@

Examp

Contents

@@ -235,7 +241,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/net.html b/docs/reference/net.html index 55bd04bc..32e2bf80 100755 --- a/docs/reference/net.html +++ b/docs/reference/net.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,13 +117,14 @@

Road network of the west part of Sao Paulo city

+

This dataset is a SpatialLineDataFrame of sp package with roads from a traffic simulations made by CET Sao Paulo, Brazil

+
data(net)
- - +

Format

A data frame with 1796 rows and 1 variables:

@@ -139,17 +139,21 @@

Formattmin

Time for travelling each link (min)

+

Source

http://www.cetsp.com.br/

+ @@ -161,7 +165,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/netspeed.html b/docs/reference/netspeed.html index aa1e8896..4ba682d9 100755 --- a/docs/reference/netspeed.html +++ b/docs/reference/netspeed.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,13 +117,15 @@

Calculate speeds of traffic network

+

netspeed Creates a dataframe of speeds fir diferent hours and each link based on morning rush traffic data

+
netspeed(q = 1, ps, ffs, cap, lkm, alpha = 0.15, beta = 4, net,
   scheme = FALSE, distance = "km", time = "h", isList)
- +

Arguments

@@ -188,10 +189,11 @@

Arg

Deprecated

- +

Value

dataframe speeds with units or sf.

+

Examples

{ @@ -214,7 +216,9 @@

Examp

Contents

@@ -228,7 +232,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/pc_cold.html b/docs/reference/pc_cold.html index 9382448f..7ff2b506 100755 --- a/docs/reference/pc_cold.html +++ b/docs/reference/pc_cold.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,28 +119,31 @@

Profile of Vehicle start patterns

+

This dataset is a dataframe with percetage of hourly starts with a lapse of 6 hours with engine turned off. Data source is: Lents J., Davis N., Nikkila N., Osses M. 2004. Sao Paulo vehicle activity study. ISSRC. www.issrc.org

+
data(pc_cold)
- - +

Format

A data frame with 24 rows and 1 variables:

V1

24 hours profile vehicle starts for Monday

+ @@ -153,7 +155,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/pc_profile.html b/docs/reference/pc_profile.html index 569a87f1..783c7501 100755 --- a/docs/reference/pc_profile.html +++ b/docs/reference/pc_profile.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,15 +119,16 @@

Profile of traffic data 24 hours 7 n days of the week

+

This dataset is a dataframe with traffic activity normalized monday 08:00-09:00. This data is normalized at 08:00-09:00. It comes from data of toll stations near Sao Paulo City. The source is ARTESP (www.artesp.com.br)

+
data(pc_profile)
- - +

Format

A data frame with 24 rows and 7 variables:

@@ -141,13 +141,15 @@

FormatV7

24 hours profile for Sunday

+ @@ -159,7 +161,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/pollutants.html b/docs/reference/pollutants.html index f1eb603b..082eee0a 100644 --- a/docs/reference/pollutants.html +++ b/docs/reference/pollutants.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,13 +117,14 @@

Data.frame with pollutants names and molar mass used in VEIN

+

This dataset also includes MIR, MOIR and EBIR is Carter SAPRC07.xls https://www.engr.ucr.edu/~carter/SAPRC/

+
data(pollutants)
- - +

Format

A data frame with 148 rows and 10 variables:

@@ -143,13 +143,15 @@

Formatnotes

Inform some assumption for molar mass

+ @@ -161,7 +163,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/profiles.html b/docs/reference/profiles.html index c38e6c84..bccffe10 100644 --- a/docs/reference/profiles.html +++ b/docs/reference/profiles.html @@ -15,13 +15,11 @@ - - @@ -41,19 +39,19 @@ - + + - @@ -100,6 +98,7 @@ Changelog + @@ -121,16 +120,17 @@

Profile of traffic data 24 hours 7 n days of the week

+

This dataset is n a list of data-frames with traffic activity normalized monday 08:00-09:00. It comes from data of toll stations near Sao Paulo City. The source is ARTESP (www.artesp.com.br) for months January and June and years 2012, 2013 and 2014. The type of vehicles covered are PC, MC, MC and HGV.

+
data(pc_profile)
- - +

Format

A list of data-frames with 24 rows and 7 variables:

@@ -159,13 +159,15 @@

FormatHGV_JANUARY_2014

168 hours

+ @@ -177,7 +179,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/remove_units.html b/docs/reference/remove_units.html index ba8be00c..05680a68 100644 --- a/docs/reference/remove_units.html +++ b/docs/reference/remove_units.html @@ -15,13 +15,11 @@ - - @@ -41,15 +39,15 @@ - + + - @@ -96,6 +94,7 @@ Changelog + @@ -117,11 +116,13 @@

Remove units

+

remove_units Remove units from data.frames, matrix or units.

+
remove_units(x)
- +

Arguments

@@ -130,10 +131,11 @@

Arg

Object with class "data.frame", "matrix" or "units"

- +

Value

"data.frame", "matrix" or numeric

+

Examples

{ @@ -211,7 +213,9 @@

Examp

Contents

@@ -225,7 +229,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/running_losses-deprecated.html b/docs/reference/running_losses-deprecated.html index 460272e1..22bcbb6f 100644 --- a/docs/reference/running_losses-deprecated.html +++ b/docs/reference/running_losses-deprecated.html @@ -15,13 +15,11 @@ - - @@ -41,18 +39,18 @@ - + + - @@ -99,6 +97,7 @@ Changelog + @@ -120,13 +119,15 @@

Estimation of average daily hot-soak evaporative emissions

+

hot_soak estimates of evaporative emissions from EMEP/EEA emisison guidelines

running_losses estimates evaporative emissions from EMEP/EEA emisison guidelines

+
- +

Arguments

@@ -189,24 +190,28 @@

Arg for vehicles with carburator or fuel return system

- +

Value

numeric vector of emission estimation in grams

numeric vector of emission estimation in grams

+

See also

+ @@ -218,7 +223,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/speciate.html b/docs/reference/speciate.html index 6c19dcd1..dd16b279 100755 --- a/docs/reference/speciate.html +++ b/docs/reference/speciate.html @@ -15,13 +15,11 @@ - - @@ -41,17 +39,17 @@ - + + - @@ -98,6 +96,7 @@ Changelog + @@ -119,14 +118,16 @@

Speciation of emissions

+

speciate separates emissions in different compounds. It covers black carbon and organic matter from particulate matter. Soon it will be added more speciations

+
speciate(x, spec = "bcom", veh, fuel, eu, show = FALSE, list = FALSE,
   pmpar)
- +

Arguments

@@ -196,10 +197,11 @@

Arg argument is preseent, new values are used.

- +

Value

dataframe of speciation in grams or mols

+

Note

when spec = "iag": @@ -213,6 +215,7 @@

Note

cidade de Manaus nas concentracoes de poluentes atmosfericos da regiao amazonica, Master thesis, Londrina: Universidade Tecnologica Federal do Parana, 2015.

+

References

"bcom": Ntziachristos and Zamaras. 2016. Passneger cars, light @@ -241,6 +244,7 @@

R stationary sources, prepared by Ying Hsu and Randy Strait of E.H. Pechan Associates, Inc. for David Niemi, Marc Deslauriers, and Lisa Graham of Environment Canada, September 26, 2006.

+

Examples

{ @@ -250,15 +254,19 @@

Examp dfa <- speciate(pm, spec = "e_eth", veh = "veh", fuel = "G", eu = "Exhaust") dfb <- speciate(pm, spec = "e_tol", veh = "veh", fuel = "G", eu = "Exhaust") dfc <- speciate(pm, spec = "e_so4i") -}

#> Error in speciate(pm, spec = "e_so4i"): object 'dfb' not found
+}
#> Error in speciate(pm, spec = "e_so4i"): objeto 'dfb' não encontrado
-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/split_emis.html b/docs/reference/split_emis.html index cbf989fa..b8cea4bb 100644 --- a/docs/reference/split_emis.html +++ b/docs/reference/split_emis.html @@ -15,13 +15,11 @@ - - @@ -41,15 +39,15 @@ - + + - @@ -96,6 +94,7 @@ Changelog + @@ -117,11 +116,13 @@

Split street emissions based on a grid

+

split_emis split street emissions into a grid.

+
split_emis(net, distance, add_column, verbose = TRUE)
- +

Arguments

@@ -145,7 +146,7 @@

Arg

Logical, to show more information.

- +

Examples

{ @@ -173,6 +174,7 @@

Examp

Contents

@@ -186,7 +188,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/temp_fact.html b/docs/reference/temp_fact.html index 5569e750..e2d93f3e 100755 --- a/docs/reference/temp_fact.html +++ b/docs/reference/temp_fact.html @@ -15,13 +15,11 @@ - - @@ -41,17 +39,17 @@ - + + - @@ -98,6 +96,7 @@ Changelog + @@ -119,13 +118,15 @@

Expansion of hourly traffic data

+

temp_fact is a matrix multiplication between traffic and hourly expansion data-frames to obtain a data-frame of traffic at each link to every hour

+
temp_fact(q, pro, net)
- +

Arguments

@@ -142,10 +143,11 @@

Arg

SpatialLinesDataFrame or Spatial Feature of "LINESTRING"

- +

Value

data-frames of expanded traffic or sf.

+

Examples

{ @@ -163,7 +165,9 @@

Examp

Contents

@@ -177,7 +181,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/to_latex.html b/docs/reference/to_latex.html index 01cfdc3f..19ac71f1 100644 --- a/docs/reference/to_latex.html +++ b/docs/reference/to_latex.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,12 +117,14 @@

creates a .tex a table from a data.frame

+

\code\linkto_latex reads a data.frme an dgenerates a .tex table, aiming to replicate the method of tablegenerator.com

+
to_latex(df, file, caption = "My table", label = "tab:df")
- +

Arguments

@@ -144,13 +145,15 @@

Arg

Character, label of table

- +

Value

a text file with extension .tex.

+

See also

\code\linkvein_notes \code\linklong_to_wide

+

Examples

{ @@ -187,14 +190,17 @@

Examp #> \end{tabular}% #> } #> \end{table} -#> /tmp/RtmpE4K6e3/file49db5c41f071.tex

+#> /tmp/Rtmpqo7rZP/file6185450bab39.tex
-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/vein-deprecated.html b/docs/reference/vein-deprecated.html index 38e21517..119cb882 100644 --- a/docs/reference/vein-deprecated.html +++ b/docs/reference/vein-deprecated.html @@ -15,13 +15,11 @@ - - @@ -41,8 +39,8 @@ - + + - @@ -104,6 +102,7 @@ Changelog + @@ -125,6 +124,7 @@

DEPRECATED Construction function for class "EmissionsList"

+

EmissionsList returns a tranformed object with class "EmissionsList".

Evaporative returns a tranformed object with class "Evaporative" and units g. This class represents the daily emissions presented by @@ -134,6 +134,7 @@

DEPRECATED Construction function for class "EmissionsList"

the near future. When possible, alternative functions with similar functionality are also mentioned. Help pages for deprecated functions are available at help("-deprecated").

+
EmissionsList(x, ...)
@@ -163,7 +164,7 @@ 

DEPRECATED Construction function for class "EmissionsList"

hot_soak(x, carb, p, eshotc, eswarmc, eshotfi) running_losses(x, erhotfi, lkm, carb, p, erhotc, erwarmc)
- +

Arguments

@@ -192,11 +193,12 @@

Arg

ignored

- +

Value

Objects of class "EmissionsList" and numeric elements as "units"

Objects of class "Evaporative" or "units"

+

Evaporative

@@ -208,6 +210,7 @@

For running_losses, use emis_evap.

For running_losses, use emis_evap.

+

References

Mellios G and Ntziachristos 2016. Gasoline evaporation. In: @@ -216,10 +219,12 @@

R

Mellios G and Ntziachristos 2016. Gasoline evaporation. In: EEA, EMEP. EEA air pollutant emission inventory guidebook-2009. European Environment Agency, Copenhagen, 2009

+

See also

vein-deprecated

vein-deprecated

+

Examples

if (FALSE) { @@ -244,10 +249,15 @@

Examp

Contents

@@ -261,7 +271,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/vein-package.html b/docs/reference/vein-package.html index 6e155c4b..7a780ad8 100644 --- a/docs/reference/vein-package.html +++ b/docs/reference/vein-package.html @@ -15,13 +15,11 @@ - - @@ -41,8 +39,8 @@ - + + - @@ -103,6 +101,7 @@ Changelog + @@ -124,6 +123,7 @@

vein: Vehicular Emissions Inventories

+

Elaboration of vehicular emissions inventories, consisting in four stages, pre-processing activity data, preparing @@ -132,10 +132,10 @@

vein: Vehicular Emissions Inventories

Before using VEIN you need to know the vehicular composition of your study area, in other words, the combination of of type of vehicles, size and fuel of the fleet. Then, it is recommended to start with the function inventory to create a structure of directories and template scripts.

+
- - +

See also

Useful links:

    @@ -144,13 +144,15 @@

    See a

+
-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/vein_notes.html b/docs/reference/vein_notes.html index 9bea530b..e92b6bf4 100644 --- a/docs/reference/vein_notes.html +++ b/docs/reference/vein_notes.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,8 +117,10 @@

vein_notes for writting technical notes about the inventory

+

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

+
vein_notes(notes, yourname, file = "README",
@@ -131,7 +132,7 @@ 

vein_notes for writting technical notes about the inventory

evaporative = "Your information about evaporative emission factors", standards = "Your information about standards", mileage = "Your information about mileage")
- +

Arguments

@@ -186,10 +187,11 @@

Arg

Character; vector of notes.

- +

Value

Writes a text file.

+

Examples

{ @@ -201,15 +203,15 @@

Examp #> [2] "Vehicular Emissions Inventory on REGIONXX BASE YEAR XXXX" #> [3] "========================================" #> [4] "" -#> [5] "Directory: /home/sergio/models/vein/docs/reference" +#> [5] "Directory: /home/sergio/Documentos/vein/docs/reference" #> [6] "" -#> [7] "Local Time: 2019-09-05 15:00:18" +#> [7] "Local Time: 2019-09-17 14:53:45" #> [8] "Inventory compiler: sergio" #> [9] "========================================" #> [10] "" #> [11] "sysname = Linux" -#> [12] "release = 5.0.0-27-generic" -#> [13] "version = #28-Ubuntu SMP Tue Aug 20 19:53:07 UTC 2019" +#> [12] "release = 5.0.0-25-generic" +#> [13] "version = #26-Ubuntu SMP Thu Aug 1 12:04:58 UTC 2019" #> [14] "nodename = sergio-pc" #> [15] "machine = x86_64" #> [16] "user = sergio" @@ -256,7 +258,9 @@

Examp

Contents

@@ -270,7 +274,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/vkm.html b/docs/reference/vkm.html index 25ebb907..e0b9686f 100755 --- a/docs/reference/vkm.html +++ b/docs/reference/vkm.html @@ -15,13 +15,11 @@ - - @@ -41,17 +39,17 @@ - + + - @@ -98,6 +96,7 @@ Changelog + @@ -119,14 +118,16 @@

Estimation of VKM

+

vkm consists in the product of the number of vehicles and the distance driven by these vehicles in km. This function reads hourly vehiles and then extrapolates the vehicles

+
vkm(veh, lkm, profile, hour = nrow(profile), day = ncol(profile),
   array = TRUE, as_df = TRUE)
- +

Arguments

@@ -160,10 +161,11 @@

Arg

Logical; when TRUE transform returning array in data.frame (streets x hour*days)

- +

Value

emission estimation of vkm

+

Examples

{ @@ -182,7 +184,9 @@

Examp

Contents

@@ -196,7 +200,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.

diff --git a/docs/reference/wide_to_long.html b/docs/reference/wide_to_long.html index 83f918c9..cb3a3ef8 100644 --- a/docs/reference/wide_to_long.html +++ b/docs/reference/wide_to_long.html @@ -15,13 +15,11 @@ - - @@ -41,16 +39,16 @@ - + + - @@ -97,6 +95,7 @@ Changelog + @@ -118,12 +117,14 @@

Transform data.frame from wide to long format

+

wide_to_long transform data.frame from wide to long format

+
wide_to_long(df, column_with_data = names(df), column_fixed, geometry)
- +

Arguments

@@ -144,13 +145,15 @@

Arg

To return a sf

- +

Value

long data.frame.

+

See also

+

Examples

{ @@ -170,8 +173,11 @@

Examp

Contents

@@ -185,7 +191,7 @@

Contents

-

Site built with pkgdown 1.4.0.

+

Site built with pkgdown 1.4.1.