Do not save metadata by default

JGCRI · Oct 17, 2024 · b2b7ead · b2b7ead
1 parent ce2cf86
commit b2b7ead
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 10 deletions.
diff --git a/R/xfaostat_helper_funcs.R b/R/xfaostat_helper_funcs.R
@@ -13,7 +13,8 @@
 #' @export
 
 gcamfaostat_metadata <- function(.DIR_RAW_DATA_FAOSTAT = file.path("inst/extdata", DIR_RAW_DATA_FAOSTAT),
-                                 OnlyReturnDatasetCodeRequired = FALSE){
+                                 OnlyReturnDatasetCodeRequired = FALSE,
+                                 Save_metadata = FALSE){
 
   assertthat::assert_that(OnlyReturnDatasetCodeRequired == TRUE|OnlyReturnDatasetCodeRequired == FALSE)
 
@@ -37,14 +38,21 @@ gcamfaostat_metadata <- function(.DIR_RAW_DATA_FAOSTAT = file.path("inst/extdata
     return(FAO_dataset_code_required)
   }
 
-  DIR_FAOSTAT_METADATA <- file.path(.DIR_RAW_DATA_FAOSTAT, "metadata_log")
-  dir.create(DIR_FAOSTAT_METADATA, showWarnings = F)
 
   # Save a table includes all FAOSTAT data info and links
   fao_metadata <- FAOSTAT_metadata() %>% filter(datasetcode %in% FAO_dataset_code_required)
-  readr::write_csv(fao_metadata, file.path(DIR_FAOSTAT_METADATA, paste0("FAOSTAT_METADATA_", Sys.Date(),".csv")))
-  rlang::inform(paste0("A Full FAOSTAT metadata downloaded and updated in `",
-                       file.path(.DIR_RAW_DATA_FAOSTAT, "metadata_log", "`")))
+
+  if (Save_metadata == TRUE) {
+
+    DIR_FAOSTAT_METADATA <- file.path(.DIR_RAW_DATA_FAOSTAT, "metadata_log")
+    dir.create(DIR_FAOSTAT_METADATA, showWarnings = F)
+
+    readr::write_csv(fao_metadata, file.path(DIR_FAOSTAT_METADATA, paste0("FAOSTAT_METADATA_", Sys.Date(),".csv")))
+    rlang::inform(paste0("A Full FAOSTAT metadata downloaded and updated in `",
+                         file.path(.DIR_RAW_DATA_FAOSTAT, "metadata_log", "`")))
+  }
+
+
   rlang::inform("---------------------------------------------------------")
 
   rlang::inform(paste0("See returned table for the infomation of FAOSTAT dataset processed in this R package"))

diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -8,7 +8,7 @@ articles:
   vignette_processing_flow: vignette_processing_flow.html
   vignette_use_cases: vignette_use_cases.html
   vignette_visualization: vignette_visualization.html
-last_built: 2024-10-17T17:10Z
+last_built: 2024-10-17T18:29Z
 urls:
   reference: https://jgcri.github.io/gcamfaostat/reference
   article: https://jgcri.github.io/gcamfaostat/articles

diff --git a/docs/reference/FAOSTAT_metadata.html b/docs/reference/FAOSTAT_metadata.html
diff --git a/docs/reference/gcamfaostat_metadata.html b/docs/reference/gcamfaostat_metadata.html
diff --git a/man/gcamfaostat_metadata.Rd b/man/gcamfaostat_metadata.Rd