check_bilateral_trade_df: Checks bilateral trade data

In earamendia/ECCTools: ECCTools Assists With Energy Conversion Chain Analysis

Checks bilateral trade data

Description

This function checks the bilateral trade data before it is provided to the transform_to_bta() function. It returns TRUE if the sum of the shares of exported products, by country of provenience and by product, is 1. Otherwise, it returns an error.

Usage

check_bilateral_trade_df(
  .bilateral_trade_df,
  country = IEATools::iea_cols$country,
  provenience = "Provenience",
  method = IEATools::iea_cols$method,
  energy_type = IEATools::iea_cols$energy_type,
  last_stage = IEATools::iea_cols$last_stage,
  year = IEATools::iea_cols$year,
  product = IEATools::iea_cols$product,
  e_dot = IEATools::iea_cols$e_dot,
  share_exports_by_product = "Share_Exports_By_Product",
  .sum_share_exports = ".sum_share_exports"
)

Arguments

.bilateral_trade_df	The bilateral trade data frame to be checked.
country	The name of the country column. Default is IEATools::iea_cols$country.
provenience	The name of the country of provenience (i.e. exporting country). Default is "Provenience".
method	The name of the Method column. Default is IEATools::iea_cols$method.
energy_type	The name of the energy type column. Default is IEATools::iea_cols$energy_type.
last_stage	The name of the last stage column. Default is IEATools::iea_cols$last_stage.
year	The name of the year column. Default is year = IEATools::iea_cols$year.
product	The name of the product column. Default is IEATools::iea_cols$product.
e_dot	The name of the E.dot column. Default is IEATools::iea_cols$e_dot.
share_exports_by_product	The name of the share of exports by product column. Default is "Share_Exports_By_Product".
.sum_share_exports	The name of the temporary sum shares of exports by product column. Default is ".sum_share_exports".

Value

Returns TRUE if the sum of the shares of exported products, by country of provenience and by product, is 1. Returns an error if otherwise.

Examples

A_B_path <- system.file("extdata/A_B_data_full_2018_format.csv", package = "ECCTools")
AB_data <- A_B_path %>%
 IEATools::load_tidy_iea_df() %>%
 IEATools::specify_all()
bilateral_trade_df_gma <- AB_data %>%
 IEATools::add_psut_matnames() %>%
 calc_bilateral_trade_df_gma()
check_bilateral_trade_df(bilateral_trade_df_gma)

earamendia/ECCTools documentation built on May 12, 2023, 2:12 a.m.