View source: R/helpers_shares.R
calc_shares_ff_by_group_inc_elec_heat | R Documentation |
This function calculates the share of use (using the matrices provided in the final_use_mats
argument) of each energy product within each fossil fuel group,
when including electricity and heat of fossil fuel origin in the calculations.
calc_shares_ff_by_group_inc_elec_heat(
.tidy_iea_df,
include_non_energy_uses = FALSE,
final_use_mats = c(IEATools::psut_cols$Y, IEATools::psut_cols$U_eiou),
list_oil_products = IEATools::oil_and_oil_products,
list_coal_products = IEATools::coal_and_coal_products,
list_gas_products = IEATools::primary_gas_products,
product.group = "Product.Group",
total_product_use = "Total_Product_Use",
total_group_use = "Total_Group_Use",
non_energy_uses = "Non_Energy_Uses",
share = "Share",
country = IEATools::iea_cols$country,
method = IEATools::iea_cols$method,
energy_type = IEATools::iea_cols$energy_type,
last_stage = IEATools::iea_cols$last_stage,
year = IEATools::iea_cols$year,
unit = IEATools::iea_cols$unit,
e_dot = IEATools::iea_cols$e_dot,
product = IEATools::iea_cols$product,
boolean_non_energy_uses = "Boolean_Non_Energy_Uses",
energy.stage = "Energy.stage",
product_without_origin = "product_without_origin"
)
.tidy_iea_df |
The |
include_non_energy_uses |
A boolean indicating whether non-energy uses should be included in the calculation of the share of uses. Default is FALSE. |
final_use_mats |
The list of matrices to be used to calculate the share of uses.
Default is |
list_oil_products |
The list of oil products to be used for the shares calculations.
Default is |
list_coal_products |
The list of coal products to be used for the shares calculations.
Default is |
list_gas_products |
The list of gas products to be used for the shares calculations.
Default is |
product.group |
The name of the column containing the product group name. Default is "Product.Group". |
total_product_use |
The name of the column containing the total energy use by product. Default is "Total_Product_Use". |
total_group_use |
The name of the column containing the total energy use by fossil fuel group. Default is "Total_Group_Use". |
non_energy_uses |
The name of the column stating whether non-energy uses are included in the shares calculations. Default is "Non_Energy_Uses". |
share |
The name of the column containing the shares of each fossil fuel within the electricity supply. Default is "Share". |
country, method, energy_type, last_stage, year, unit, e_dot, product |
See |
boolean_non_energy_uses |
The column name of a column containing a boolean stating whether non-energy uses are included in the shares calculations. Default is "Boolean_Non_Energy_Uses". |
energy.stage |
The name of the column containing the energy stage. Default is "Energy.stage". |
product_without_origin |
The name of the column containing the product name without the product origin. Default is "product_without_origin" |
The function can work both on a single country Energy Conversion Chain of Domestic Technology Assumption type,
or with a multi-regional Energy Conversion Chain for instance using the Global Market Assumption. The input data frame
will have to be slightly adapted in this case (for an example see the tests related to the function).
Non-energy uses can be included or excluded using the include_non_energy_uses
argument.
A .tidy_iea_df
with the shares of use of each energy product within each fossil fuel group.
ECCTools::tidy_AB_data %>%
IEATools::add_psut_matnames() %>%
ECCTools::transform_to_dta() %>%
calc_shares_ff_by_group_inc_elec_heat()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.