Merge pull request #12 from eduaguilera/catalin/build-supply-use-tables

Build supply use tables

Author: lbm364dl

R/input_files.R

@@ -94,7 +94,8 @@ get_file_path <- function(file_alias, force_download = FALSE) {
 }
 
 .fetch_file_info <- function(file_alias) {
-  file_info <- dplyr::filter(.get_input_files_data(), alias == file_alias)
+  input_files <- .read_local_csv("input/raw/input_files.csv")
+  file_info <- dplyr::filter(input_files, alias == file_alias)
 
   if (nrow(file_info) == 0) {
     stop(stringr::str_glue("There is no file entry with alias {file_alias}"))
@@ -114,8 +115,8 @@ get_file_path <- function(file_alias, force_download = FALSE) {
   c(file_info)
 }
 
-.get_input_files_data <- function() {
+.read_local_csv <- function(csv_path) {
   "extdata" |>
-    system.file("input/raw/input_files.csv", package = utils::packageName()) |>
+    system.file(csv_path, package = utils::packageName()) |>
     readr::read_csv(show_col_types = FALSE)
 }

R/supply_use.R

@@ -0,0 +1,130 @@
+# TODO: Revisit the whole file. I'm pretty sure there are mistakes,
+# along with incomplete parts. It's better to first finish the model
+# and then come back here.
+
+#' Supply and use tables
+#'
+#' @description
+#' Create a table with processes, their inputs (_use_) and their
+#' outputs (_supply_).
+#'
+#' @returns
+#' A tibble with the supply and use data for processes.
+#' It contains the following columns:
+#' - `year`: The year in which the recorded event occurred.
+#' - `area`: The name of the country where the data is from.
+#' - `proc`: Natural language name of the process taking place.
+#' - `item`: Natural language name of the item taking part in the process.
+#' - `type`: Can have two values:
+#'    - `use`: The given item is an input of the process.
+#'    - `supply`: The given item is an output of the process.
+#' - `value`: Quantity in tonnes.
+#'
+#' @export
+#'
+#' @examples
+#' \dontrun{
+#' build_supply_use()
+#' }
+build_supply_use <- function() {
+  # TODO: There's a name mismatch in two items
+  # CBS_item                  supply_process_item
+  # Fodder cereal and grasses Fodder crops
+  # Fodder legumes            Grazing
+  # Keep balance sheet names for now
+
+  .build_supply_use_from_inputs(
+    supply_processes = .read_local_csv("input/raw/items_supply.csv"),
+    use_processes = .read_local_csv("input/raw/items_use.csv"),
+    coeffs = get_processing_coefs(get_file_path("processing_coefs")),
+    cbs = get_wide_cbs(get_file_path("commodity_balance_sheet"))
+  )
+}
+
+.build_supply_use_from_inputs <- function(
+    supply_processes,
+    use_processes,
+    coeffs,
+    cbs) {
+  processes_table <- .join_supply_use_processes(supply_processes, use_processes)
+
+  tibble::tibble() |>
+    .add_use_for_feed(processes_table) |>
+    .add_use_for_seed(processes_table, cbs) |>
+    .add_use_for_slaughtering(processes_table) |>
+    .add_supply_use_for_processing(processes_table, coeffs) |>
+    .add_rest_of_supply(supply_processes, cbs)
+}
+
+.join_supply_use_processes <- function(supply_processes, use_processes) {
+  use_processes |>
+    dplyr::full_join(
+      supply_processes,
+      by = c("proc", "proc_code"),
+      relationship = "many-to-many",
+      suffix = c("_to_process", "_processed")
+    )
+}
+
+.add_rest_of_supply <- function(supply_use, supply_process_table, cbs) {
+  items_done <- supply_use |>
+    dplyr::filter(type == "supply") |>
+    dplyr::distinct(item)
+
+  cbs |>
+    dplyr::anti_join(items_done, "item") |>
+    dplyr::inner_join(supply_process_table, "item") |>
+    dplyr::filter(domestic_supply > 0) |>
+    dplyr::select(year, area, proc, item, domestic_supply) |>
+    dplyr::rename(value = domestic_supply) |>
+    dplyr::mutate(type = "supply") |>
+    dplyr::bind_rows(supply_use)
+}
+
+.add_use_for_seed <- function(supply_use, processes_table, cbs) {
+  processes_table |>
+    dplyr::filter(type == "seedwaste") |>
+    # TODO: compare with full_join, why seedwaste use on animal products?
+    dplyr::inner_join(cbs, dplyr::join_by(item_code_to_process == item_code)) |>
+    dplyr::filter(seed > 0) |>
+    dplyr::select(year, area, proc, item_to_process, seed) |>
+    dplyr::rename(item = item_to_process, value = seed) |>
+    dplyr::mutate(type = "use") |>
+    dplyr::bind_rows(supply_use)
+}
+
+# TODO: Treat slaughtering processes
+# (probably need conversion factor from Livestock Units to physical unit)
+.add_use_for_slaughtering <- function(supply_use, processes_table) {
+  supply_use
+}
+
+# TODO: Treat animal feed use processes
+# Use feed intake data from Eduardo
+.add_use_for_feed <- function(supply_use, processes_table) {
+  supply_use
+}
+
+.add_supply_use_for_processing <- function(
+    supply_use,
+    processes_table,
+    coeffs) {
+  processes <- processes_table |>
+    dplyr::filter(!type %in% c("feed", "seedwaste", "slaughtering")) |>
+    # TODO: compare with full_join, deal with missing processes
+    dplyr::inner_join(coeffs, by = c("item_processed", "item_to_process"))
+
+  supply <- processes |>
+    dplyr::group_by(year, area, proc, item_processed) |>
+    dplyr::summarise(value = sum(final_value_processed)) |>
+    dplyr::ungroup() |>
+    dplyr::rename(item = item_processed) |>
+    dplyr::mutate(type = "supply")
+
+  use <- processes |>
+    dplyr::distinct(year, area, proc, item_to_process, value_to_process) |>
+    dplyr::rename(item = item_to_process, value = value_to_process) |>
+    dplyr::mutate(type = "use")
+
+  dplyr::bind_rows(supply, use, supply_use)
+}

R/utils.R

@@ -2,28 +2,36 @@
 utils::globalVariables(
   c(
     "alias",
+    "area",
     "area_code",
     "area_code_p",
     "balanced_export",
     "balanced_import",
     "bilateral_trade",
     "cf",
+    "domestic_supply",
     "element",
     "Element",
     "export",
+    "final_value_processed",
     "from_code",
     "import",
     "Imp/Exp",
     "Info_Format",
     "item",
     "Item",
     "item_code",
+    "item_code_to_process",
+    "item_processed",
+    "item_to_process",
     "Name",
     "No",
+    "proc",
     "processeditem",
     "product_fraction",
     "SACO_link",
     "scaling",
+    "seed",
     "sex",
     "stock_variation",
     "Timeline_End",
@@ -34,11 +42,13 @@ utils::globalVariables(
     "total_trade",
     "to_code",
     "Trade",
+    "type",
     "unit",
     "value",
     "Value",
     "value_proc",
     "value_proc_raw",
+    "value_to_process",
     "year",
     "Year"
   )

inst/extdata/input/raw/items_supply.csv

@@ -0,0 +1,165 @@
+proc_code,proc,comm_code,item_code,item
+p001,Rice production,c001,2807,Rice and products
+p002,Wheat production,c002,2511,Wheat and products
+p003,Barley production,c003,2513,Barley and products
+p004,Maize production,c004,2514,Maize and products
+p005,Rye production,c005,2515,Rye and products
+p006,Oat production,c006,2516,Oats
+p007,Millet production,c007,2517,Millet and products
+p008,Sorghum production,c008,2518,Sorghum and products
+p009,"Cereals production, Other",c009,2520,"Cereals, Other"
+p010,Potatoes  production,c010,2531,Potatoes and products
+p011,Cassava production,c011,2532,Cassava and products
+p012,Sweet potatoes production,c012,2533,Sweet potatoes
+p013,"Roots production, Other",c013,2534,"Roots, Other"
+p014,Yams production,c014,2535,Yams
+p015,Sugar cane production,c015,2536,Sugar cane
+p016,Sugar beet production,c016,2537,Sugar beet
+p017,Beans production,c017,2546,Beans
+p018,Peas production,c018,2547,Peas
+p019,"Pulses  production, Other",c019,2549,"Pulses, Other and products"
+p020,Nuts production,c020,2551,Nuts and products
+p021,Soyabeans production,c021,2555,Soyabeans
+p022,Groundnuts production,c022,2552,Groundnuts
+p023,Sunflower seed production,c023,2557,Sunflower seed
+p024,Rape and Mustardseed production,c024,2558,Rape and Mustardseed
+p025,Seed cotton production,c025,328,Seed cotton
+p026,Coconuts production,c026,2560,Coconuts - Incl Copra
+p027,Sesame seed production,c027,2561,Sesame seed
+p028,Oil palm fruit production,c028,254,"Oil, palm fruit"
+p029,Olives production,c029,2563,Olives (including preserved)
+p030,"Oilcrops production, Other",c030,2570,"Oilcrops, Other"
+p031,Tomatoes production,c031,2601,Tomatoes and products
+p032,Onions production,c032,2602,Onions
+p033,"Vegetables production, Other",c033,2605,"Vegetables, Other"
+p034,"Oranges, Mandarines production",c034,2611,"Oranges, Mandarines"
+p035,"Lemons, Limes production",c035,2612,"Lemons, Limes and products"
+p036,Grapefruit production,c036,2613,Grapefruit and products
+p037,"Citrus production, Other",c037,2614,"Citrus, Other"
+p038,Bananas production,c038,2615,Bananas
+p039,Plantains production,c039,2616,Plantains
+p040,Apples production,c040,2617,Apples and products
+p041,Pineapples production,c041,2618,Pineapples and products
+p042,Dates production,c042,2619,Dates
+p043,Grapes production,c043,2620,Grapes and products (excl wine)
+p044,"Fruits production, Other",c044,2625,"Fruits, Other"
+p045,Coffee production,c045,2630,Coffee and products
+p046,Cocoa Beans production,c046,2633,Cocoa Beans and products
+p047,Tea production,c047,2635,Tea (including mate)
+p048,Hops production,c048,677,Hops
+p049,Pepper production,c049,2640,Pepper
+p050,Pimento production,c050,2641,Pimento
+p051,Cloves production,c051,2642,Cloves
+p052,"Spices production, Other",c052,2645,"Spices, Other"
+p053,Jute production,c053,2662,Jute
+p054,Jute-Like Fibres production,c054,2663,Jute-Like Fibres
+p055,"Soft-Fibres production, Other",c055,2664,"Soft-Fibres, Other"
+p056,Sisal production,c056,2665,Sisal
+p057,Abaca production,c057,2666,Abaca
+p058,"Hard Fibres production, Other",c058,2667,"Hard Fibres, Other"
+p059,Tobacco production,c059,2671,Tobacco
+p060,Rubber production,c060,2672,Rubber
+p061,Fodder crops production,c061,2000,Fodder crops
+p062,Grazing production,c062,2001,Grazing
+p063,Cotton production,c063,2559,Cottonseed
+p063,Cotton production,c096,2661,Cotton lint
+p064,"Sugar production, non-centrifugal",c065,2541,Sugar non-centrifugal
+p065,Sugar production,c067,2542,"Sugar (Raw Equivalent)"
+p066,"Sweeteners production, Other",c068,2543,"Sweeteners, Other"
+p067,Soyabean Oil extraction,c069,2571,Soyabean Oil
+p068,Groundnut Oil extraction,c070,2572,Groundnut Oil
+p069,Sunflowerseed Oil extraction,c071,2573,Sunflowerseed Oil
+p070,Rape and Mustard Oil extraction,c072,2574,Rape and Mustard Oil
+p071,Cottonseed Oil extraction,c073,2575,Cottonseed Oil
+p072,Palmkernel Oil extraction,c074,2576,Palmkernel Oil
+p073,Palm Oil production,c064,2562,Palm kernels
+p073,Palm Oil production,c075,2577,Palm Oil
+p074,Coconut Oil extraction,c076,2578,Coconut Oil
+p075,Sesameseed Oil extraction,c077,2579,Sesameseed Oil
+p076,Olive Oil extraction,c078,2580,Olive Oil
+p077,Ricebran Oil extraction,c079,2581,Ricebran Oil
+p078,Maize Germ Oil extraction,c080,2582,Maize Germ Oil
+p079,"Oilcrops Oil extraction, Other",c081,2586,"Oilcrops Oil, Other"
+p067,Soyabean Oil extraction,c082,2590,Soyabean Cake
+p068,Groundnut Oil extraction,c083,2591,Groundnut Cake
+p069,Sunflowerseed Oil extraction,c084,2592,Sunflowerseed Cake
+p070,Rape and Mustard Oil extraction,c085,2593,Rape and Mustard Cake
+p071,Cottonseed Oil extraction,c086,2594,Cottonseed Cake
+p072,Palmkernel Oil extraction,c087,2595,Palmkernel Cake
+p074,Coconut Oil extraction,c088,2596,Copra Cake
+p075,Sesameseed Oil extraction,c089,2597,Sesameseed Cake
+p077,Ricebran Oil extraction,c090,2598,"Oilseed Cakes, Other"
+p078,Maize Germ Oil extraction,c090,2598,"Oilseed Cakes, Other"
+p079,"Oilcrops Oil extraction, Other",c090,2598,"Oilseed Cakes, Other"
+p080,Wine production,c091,2655,Wine
+p081,Beer production,c092,2656,Beer
+p082,"Beverages production, Fermented",c093,2657,"Beverages, Fermented"
+p083,"Beverages production, Alcoholic",c094,2658,"Beverages, Alcoholic"
+p084,"Alcohol production, Non-Food",c095,2659,"Alcohol, Non-Food"
+p085,Cattle husbandry,c097,866,Cattle
+p086,Buffaloes husbandry,c098,946,Buffaloes
+p087,Sheep husbandry,c099,976,Sheep
+p088,Goats husbandry,c100,1016,Goats
+p089,Pigs farming,c101,1034,Pigs
+p090,Poultry Birds farming,c102,2029,Poultry Birds
+p091,Horses husbandry,c103,1096,Horses
+p092,Asses husbandry,c104,1107,Asses
+p093,Mules husbandry,c105,1110,Mules
+p094,Camels husbandry,c106,1126,Camels
+p095,"Camelids husbandry, other",c107,1157,"Camelids, other"
+p096,Rabbits husbandry,c108,1140,Rabbits and hares
+p097,"Rodents husbandry, other",c109,1150,"Rodents, other"
+p099,Dairy cattle husbandry,c110,2848,Milk - Excluding Butter
+p100,Dairy buffaloes husbandry,c110,2848,Milk - Excluding Butter
+p101,Dairy sheep husbandry,c110,2848,Milk - Excluding Butter
+p102,Dairy goats husbandry,c110,2848,Milk - Excluding Butter
+p103,Dairy camels husbandry,c110,2848,Milk - Excluding Butter
+p121,Butter production,c111,2740,"Butter, Ghee"
+p104,Cattle slaughtering,c114,2731,Bovine Meat
+p105,Buffaloes slaughtering,c114,2731,Bovine Meat
+p106,Sheep slaughtering,c115,2732,Mutton & Goat Meat
+p107,Goat slaughtering,c115,2732,Mutton & Goat Meat
+p106,Sheep slaughtering,c113,2746,Wool (Clean Eq.)
+p108,Pigs slaughtering,c116,2733,Pigmeat
+p109,Poultry slaughtering,c117,2734,Poultry Meat
+p109,Poultry slaughtering,c112,2744,Eggs
+p110,Horses slaughtering,c118,2735,"Meat, Other"
+p111,Asses slaughtering,c118,2735,"Meat, Other"
+p112,Mules slaughtering,c118,2735,"Meat, Other"
+p113,Camels slaughtering,c118,2735,"Meat, Other"
+p114,"Camelids slaughtering, other",c118,2735,"Meat, Other"
+p115,Rabbits slaughtering,c118,2735,"Meat, Other"
+p116,"Rodents slaughtering, other",c118,2735,"Meat, Other"
+p104,Cattle slaughtering,c119,2736,"Offals, Edible"
+p105,Buffaloes slaughtering,c119,2736,"Offals, Edible"
+p106,Sheep slaughtering,c119,2736,"Offals, Edible"
+p107,Goat slaughtering,c119,2736,"Offals, Edible"
+p108,Pigs slaughtering,c119,2736,"Offals, Edible"
+p109,Poultry slaughtering,c119,2736,"Offals, Edible"
+p110,Horses slaughtering,c119,2736,"Offals, Edible"
+p111,Asses slaughtering,c119,2736,"Offals, Edible"
+p112,Mules slaughtering,c119,2736,"Offals, Edible"
+p113,Camels slaughtering,c119,2736,"Offals, Edible"
+p114,"Camelids slaughtering, other",c119,2736,"Offals, Edible"
+p115,Rabbits slaughtering,c119,2736,"Offals, Edible"
+p116,"Rodents slaughtering, other",c119,2736,"Offals, Edible"
+p104,Cattle slaughtering,c120,2737,"Fats, Animals, Raw"
+p105,Buffaloes slaughtering,c120,2737,"Fats, Animals, Raw"
+p106,Sheep slaughtering,c120,2737,"Fats, Animals, Raw"
+p107,Goat slaughtering,c120,2737,"Fats, Animals, Raw"
+p108,Pigs slaughtering,c120,2737,"Fats, Animals, Raw"
+p109,Poultry slaughtering,c120,2737,"Fats, Animals, Raw"
+p110,Horses slaughtering,c120,2737,"Fats, Animals, Raw"
+p111,Asses slaughtering,c120,2737,"Fats, Animals, Raw"
+p112,Mules slaughtering,c120,2737,"Fats, Animals, Raw"
+p113,Camels slaughtering,c120,2737,"Fats, Animals, Raw"
+p114,"Camelids slaughtering, other",c120,2737,"Fats, Animals, Raw"
+p115,Rabbits slaughtering,c120,2737,"Fats, Animals, Raw"
+p116,"Rodents slaughtering, other",c120,2737,"Fats, Animals, Raw"
+p104,Cattle slaughtering,c121,2748,Hides and skins
+p105,Buffaloes slaughtering,c121,2748,Hides and skins
+p106,Sheep slaughtering,c121,2748,Hides and skins
+p107,Goat slaughtering,c121,2748,Hides and skins
+p118,Beekeeping,c123,2745,Honey
+p119,Silkworm breeding,c124,2747,Silk
+p120,Fishing,c125,2960,"Fish, Seafood"