Complete docs and fix tests

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

@@ -13,13 +13,12 @@
 #' 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.
-#' - `area_code`: FAOSTAT internal code for each country. Equivalences
-#'    with ISO 3166-1 numeric can be found in the _Area Codes_ CSV from the
-#'    zip file that can be downloaded from
-#'    [FAOSTAT](https://www.fao.org/faostat/en/#data/FBS). TODO: Think about
-#'    this, would be nice to use ISO3 codes but won't be enough for our periods
-#' - `item`: Natural language name for the item.
-#' - `item_code`: FAOSTAT internal code for each item.
+#' - `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
 #'

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"
   )

man/build_supply_use.Rd

@@ -1,6 +1,6 @@
 testthat::test_that("get_file_path fails for non-existent file_alias", {
   testthat::local_mocked_bindings(
-    .get_input_files_data = function(...) {
+    .read_local_csv = function(...) {
       dplyr::tribble(
         ~extension, ~alias, ~drive_file_id,
         "csv", "file_alias_1", "some_id"
@@ -18,7 +18,7 @@ testthat::test_that(
   "get_file_path fails for duplicated entries only in filtered rows",
   {
     testthat::local_mocked_bindings(
-      .get_input_files_data = function(...) {
+      .read_local_csv = function(...) {
         dplyr::tribble(
           ~extension, ~alias, ~drive_file_id,
           "csv", "file_alias_1", "some_id",
@@ -52,7 +52,7 @@ testthat::test_that(
     testthat::expect_false(file.exists(destfile))
 
     testthat::local_mocked_bindings(
-      .get_input_files_data = function(...) {
+      .read_local_csv = function(...) {
         dplyr::tribble(
           ~extension, ~alias, ~drive_file_id,
           "csv", file_alias, "some_id",