update display of collections in Readme + very minor modifs

ptaconet · Nov 12, 2024 · 41615f0 · 41615f0
1 parent 715e8fa
commit 41615f0
Show file tree

Hide file tree

Showing 8 changed files with 1,096 additions and 371 deletions.
diff --git a/R/mf_download_data.R b/R/mf_download_data.R
@@ -161,7 +161,7 @@ mf_download_data <- function(df_to_dl, path = tempfile("modisfast_"), parallel =
     if (verbose %in% c("inform","debug")) {
        maxFileSizeEstimated <- sum(data_dl$maxFileSizeEstimated[which(data_dl$fileDl == FALSE)])
        maxFileSizeEstimated <- dplyr::if_else(round(maxFileSizeEstimated/1000000)>1,round(maxFileSizeEstimated/1000000),1)
-       cat("Downloading the data ... (destination folder:",path,")\nEstimated maximum size of data to be downloaded is ~",maxFileSizeEstimated,"Mb\n")
+       cat("Downloading the data (destination folder:",path,") ...\nEstimated maximum size of data to be downloaded is ~",maxFileSizeEstimated,"Mb\n")
       # cat("Downloading the data in",path,"...\n")
     }
     if (parallel) {

diff --git a/R/mf_login.R b/R/mf_login.R
@@ -40,7 +40,7 @@ mf_login <- function(credentials, verbose = "inform") {
   } else if (verbose == "debug"){
     x <- httr::with_verbose(f())
   }
-  httr::stop_for_status(x, "login to Earthdata. Wrong username / password, or service / servers unavailable.")
+  httr::stop_for_status(x, "login to Earthdata. Wrong username / password, or service / servers unavailable")
   httr::warn_for_status(x)
   options(earthdata_user = credentials[1])
   options(earthdata_pass = credentials[2])

diff --git a/R/mf_modisfast.R b/R/mf_modisfast.R
@@ -6,6 +6,9 @@
 #' Earth Observation data quickly and efficiently.
 #' This function is a wrapper for
 #' \link{mf_login}, \link{mf_get_url}, \link{mf_download_data} and \link{mf_import_data}.
+#' Whenever possible, users should prefer executing the functions \link{mf_login},
+#' \link{mf_get_url}, \link{mf_download_data} and \link{mf_import_data} sequentially
+#' rather than using this high-level function
 #'
 #' @inheritParams mf_get_url
 #' @inheritParams mf_download_data
@@ -19,8 +22,6 @@
 #' object ; else a data.frame providing details of the data downloaded
 #' (see output of \link{mf_download_data}).
 #'
-#' @note Whenever possible, users should prefer executing the functions \link{mf_login}, \link{mf_get_url}, \link{mf_download_data} and \link{mf_import_data} sequentially rather than using this \code{modisfast} high-level function
-#'
 #' @seealso \link{mf_login}, \link{mf_get_url}, \link{mf_download_data}, \link{mf_import_data}
 #' @export
 #' @examples

diff --git a/README.Rmd b/README.Rmd
@@ -183,8 +183,13 @@ library(kableExtra)
 mf_list_collections() %>%
   dplyr::filter(source %in% c("MODIS", "VIIRS")) %>%
   dplyr::mutate(collection = cell_spec(collection, "html", link = doi)) %>%
-  dplyr::select(collection, source, long_name, nature) %>%
-  dplyr::rename(Collection = collection, Type = nature, Name = long_name, Source = source) %>%
+  dplyr::mutate(spatial_resolution_m = paste0(spatial_resolution_m, " m")) %>%
+  dplyr::mutate(temporal_resolution = paste0(temporal_resolution," ",temporal_resolution_unit)) %>%
+  dplyr::mutate(temporal_resolution = ifelse(temporal_resolution=="1 day", "Daily", temporal_resolution)) %>%
+  dplyr::mutate(start_date = paste0(start_date," to present")) %>%
+  dplyr::select(collection, source, nature, long_name, spatial_resolution_m, temporal_resolution, start_date) %>%
+  dplyr::arrange(nature, source, spatial_resolution_m, rev(temporal_resolution)) %>% 
+  dplyr::rename(Collection = collection, Type = nature, Name = long_name, Source = source, 'Spatial resolution' = spatial_resolution_m, 'Temporal resolution' = temporal_resolution, 'Temporal extent' = start_date) %>%
   kable("html", escape = FALSE) %>%
   kable_styling(bootstrap_options = c("hover", "condensed"))
 ```
@@ -200,8 +205,13 @@ library(kableExtra)
 mf_list_collections() %>%
   dplyr::filter(!(source %in% c("MODIS", "VIIRS"))) %>%
   dplyr::mutate(collection = cell_spec(collection, "html", link = doi)) %>%
-  dplyr::select(collection, source, long_name, nature) %>%
-  dplyr::rename(Collection = collection, Type = nature, Name = long_name, Source = source) %>%
+  dplyr::mutate(spatial_resolution_m = paste0(spatial_resolution_m, " m")) %>%
+  dplyr::mutate(temporal_resolution = paste0(temporal_resolution," ",temporal_resolution_unit)) %>%
+  dplyr::mutate(temporal_resolution = ifelse(temporal_resolution=="1 day", "Daily", temporal_resolution)) %>%
+  dplyr::mutate(start_date = paste0(start_date," to present")) %>%
+  dplyr::select(collection, source, nature, long_name, spatial_resolution_m, temporal_resolution, start_date) %>%
+  dplyr::arrange(nature, source, spatial_resolution_m, rev(temporal_resolution)) %>% 
+  dplyr::rename(Collection = collection, Type = nature, Name = long_name, Source = source, 'Spatial resolution' = spatial_resolution_m, 'Temporal resolution' = temporal_resolution, 'Temporal extent' = start_date) %>%
   kable("html", escape = FALSE) %>%
   kable_styling(bootstrap_options = c("hover", "condensed"))
 ```