From b2b7ead64eb3e0c713babd70121e618c2662daa3 Mon Sep 17 00:00:00 2001 From: "Zhao, Xin" Date: Thu, 17 Oct 2024 14:30:56 -0400 Subject: [PATCH] Do not save metadata by default --- R/xfaostat_helper_funcs.R | 20 ++++++++++++++------ docs/pkgdown.yml | 2 +- docs/reference/FAOSTAT_metadata.html | 2 +- docs/reference/gcamfaostat_metadata.html | 3 ++- man/gcamfaostat_metadata.Rd | 3 ++- 5 files changed, 20 insertions(+), 10 deletions(-) diff --git a/R/xfaostat_helper_funcs.R b/R/xfaostat_helper_funcs.R index 032c2c54..73ad4c8d 100644 --- 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 index d51fdc1b..90c1d7d0 100644 --- 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 index 659bd319..f2efd8f0 100644 --- a/docs/reference/FAOSTAT_metadata.html +++ b/docs/reference/FAOSTAT_metadata.html @@ -123,7 +123,7 @@

Examples

#> } #> return(metadata) #> } -#> <bytecode: 0x00000000489615c0> +#> <bytecode: 0x0000000044e48810> #> <environment: namespace:gcamfaostat> diff --git a/docs/reference/gcamfaostat_metadata.html b/docs/reference/gcamfaostat_metadata.html index bc47cbd4..63609587 100644 --- a/docs/reference/gcamfaostat_metadata.html +++ b/docs/reference/gcamfaostat_metadata.html @@ -97,7 +97,8 @@

gcamfaostat_metadata: generate metadata information of the input data

gcamfaostat_metadata(
   .DIR_RAW_DATA_FAOSTAT = file.path("inst/extdata", DIR_RAW_DATA_FAOSTAT),
-  OnlyReturnDatasetCodeRequired = FALSE
+  OnlyReturnDatasetCodeRequired = FALSE,
+  Save_metadata = FALSE
 )
diff --git a/man/gcamfaostat_metadata.Rd b/man/gcamfaostat_metadata.Rd index 2b4183bd..cf8aa1ac 100644 --- a/man/gcamfaostat_metadata.Rd +++ b/man/gcamfaostat_metadata.Rd @@ -6,7 +6,8 @@ \usage{ gcamfaostat_metadata( .DIR_RAW_DATA_FAOSTAT = file.path("inst/extdata", DIR_RAW_DATA_FAOSTAT), - OnlyReturnDatasetCodeRequired = FALSE + OnlyReturnDatasetCodeRequired = FALSE, + Save_metadata = FALSE ) } \arguments{