changed some verbose comment to cli

Author: ptaconet

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 data size to download 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) {
@@ -207,8 +207,8 @@ mf_download_data <- function(df_to_dl, path = tempfile("modisfast_"), parallel =
     actualFileSize <- dplyr::if_else(round(actualFileSize/1000000)>1,round(actualFileSize/1000000),1)
 
     if (verbose %in% c("inform","debug")) {
-      cat("\nData were all properly downloaded under the folder(s) ", paste(as.character(unique(dirname(df_to_dl$destfile))), collapse = " and "))
-      cat("\nActual data size is",actualFileSize,"Mb\n")
+      cli::cli_alert_success(paste0("\nData were all properly downloaded under the folder(s) ", paste(as.character(unique(dirname(df_to_dl$destfile))), collapse = " and ")))
+      cat("\nActual size of downloaded data is",actualFileSize,"Mb\n")
       cli::cli_alert_info("\nTo import the data in R, use the function modisfast::mf_import_data() rather than terra::rast() or stars::read_stars(). More info at help(mf_import_data)\n")
     }
   }

R/mf_get_url.R

@@ -174,7 +174,7 @@ mf_get_url <- function(collection,
 
   if (verbose %in% c("inform","debug")) {
     cli::cli_alert_success("URL(s) built.\n")
-    cat("Estimated maximum data size is",maxFileSizeEstimated,"Mb\n")
+    cat("Estimated maximum size of data to be downloaded is",maxFileSizeEstimated,"Mb\n")
   }
 
   return(table_urls)

README.Rmd

@@ -21,9 +21,9 @@ library(dplyr)
 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/modisfast)](https://cran.r-project.org/package=modisfast)
 [![Github_Status_Badge](https://img.shields.io/badge/Github-0.9.2-blue.svg)](https://github.com/ptaconet/modisfast)
 [![R-CMD-check](https://github.com/ptaconet/modisfast/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ptaconet/modisfast/actions/workflows/R-CMD-check.yaml)
-[![CRAN_downloads](https://cranlogs.r-pkg.org/badges/grand-total/modisfast)
-[![SWH](https://archive.softwareheritage.org/badge/origin/https://github.com/ptaconet/modisfast/)](https://archive.softwareheritage.org/browse/origin/?origin_url=https://github.com/ptaconet/modisfast)
+<!-- [![SWH](https://archive.softwareheritage.org/badge/origin/https://github.com/ptaconet/modisfast/)](https://archive.softwareheritage.org/browse/origin/?origin_url=https://github.com/ptaconet/modisfast) -->
 <!-- [![DOI-zenodo](https://zenodo.org/badge/doi/10.5281/zenodo.8475.svg)](https://doi.org/10.5281/zenodo.12772739) -->
+[![CRAN_downloads](https://cranlogs.r-pkg.org/badges/grand-total/modisfast)
 [![DOI](https://joss.theoj.org/papers/abd5750a442de6a9d95b60bf49c440cb/status.svg)](https://joss.theoj.org/papers/abd5750a442de6a9d95b60bf49c440cb)
 <!-- badges: end -->
 
@@ -49,8 +49,8 @@ This package enables to build OPeNDAP (https) URLs given input parameters such a
   • <a href="#installation">Installation</a><br>
   • <a href="#get-started">Get started</a><br>
   • <a href="#collections-available-in-modisfast">Data collections available</a><br>
-  • <a href="#foundational-framework">Foundational framework</a><br>
   • <a href="#manual-testing-of-the-functionality">Manual testing of the functionality</a><br>
+  • <a href="#foundational-framework">Foundational framework</a><br>
   • <a href="#comparison-with-similar-r-packages">Comparison with similar R packages</a><br>
   • <a href="#citation">Citation</a><br>
   • <a href="#future-developments">Future developments</a><br>
@@ -209,6 +209,18 @@ mf_list_collections() %>%
 </p>
 </details>
 
+## Manual testing of the functionality
+
+Since most `modisfast` functions depend on EarthData credentials, automated tests are disabled. However, after installation, users can manually test the package's functionality by running these lines of code :
+
+```{r, eval = F, echo=T,message=F}
+# replace "username" and "password" with your own EOSDIS (Earthdata) credentials 
+earthdata_un <- "username" 
+earthdata_pw <- "password"
+
+devtools::test("modisfast")
+```
+
 ## Foundational framework  {#foundational-framework}
 
 Technically, `modisfast` is a programmatic interface (R wrapper) to several NASA [OPeNDAP](https://www.opendap.org/) servers. OPeNDAP is the acronym for *Open-source Project for a Network Data Access Protocol* and designates both the software, the access protocol, and the corporation that develops them. The OPeNDAP is designed to simplify access to structured and high-volume data, such as satellite products, over the Web. It is a collaborative effort involving multiple institutions and companies, with open-source code, free software, and adherence to the [Open Geospatial Consortium](https://www.ogc.org/) (OGC) standards. It is widely used by NASA, which partly finances it. 
@@ -231,19 +243,6 @@ The indices within the `[]` refer to values encoding for the spatial and tempora
 
 These OPeNDAP URLs are not trivial to build. `modisfast` converts the spatial, temporal and dimensional filters (R objects) provided by the user through the function `mf_get_url()` into the appropriate OPeNDAP URL(s). Subsequently, the function `mf_download_data()` allows for downloading the data using the [`httr`](https://cran.r-project.org/package=httr) and `parallel` packages. 
 
-## Manual testing of the functionality
-
-Since most `modisfast` functions depend on EarthData credentials, automated tests are disabled. However, after installation, users can manually test the package's functionality by running these lines of code :
-
-```{r, eval = F, echo=T,message=F}
-# replace "username" and "password" with your own EOSDIS (Earthdata) credentials 
-earthdata_un <- "username" 
-earthdata_pw <- "password"
-
-devtools::test("modisfast")
-```
-
-
 ## Comparison with similar R packages
 
 There are other R packages available for accessing MODIS data. Below is a comparison of modisfast with other packages available for downloading chunks of MODIS or VIIRS data :

README.md

@@ -10,9 +10,9 @@
 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/modisfast)](https://cran.r-project.org/package=modisfast)
 [![Github_Status_Badge](https://img.shields.io/badge/Github-0.9.2-blue.svg)](https://github.com/ptaconet/modisfast)
 [![R-CMD-check](https://github.com/ptaconet/modisfast/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ptaconet/modisfast/actions/workflows/R-CMD-check.yaml)
-\[![CRAN_downloads](https://cranlogs.r-pkg.org/badges/grand-total/modisfast)
-[![SWH](https://archive.softwareheritage.org/badge/origin/https://github.com/ptaconet/modisfast/)](https://archive.softwareheritage.org/browse/origin/?origin_url=https://github.com/ptaconet/modisfast)
+<!-- [![SWH](https://archive.softwareheritage.org/badge/origin/https://github.com/ptaconet/modisfast/)](https://archive.softwareheritage.org/browse/origin/?origin_url=https://github.com/ptaconet/modisfast) -->
 <!-- [![DOI-zenodo](https://zenodo.org/badge/doi/10.5281/zenodo.8475.svg)](https://doi.org/10.5281/zenodo.12772739) -->
+\[![CRAN_downloads](https://cranlogs.r-pkg.org/badges/grand-total/modisfast)
 [![DOI](https://joss.theoj.org/papers/abd5750a442de6a9d95b60bf49c440cb/status.svg)](https://joss.theoj.org/papers/abd5750a442de6a9d95b60bf49c440cb)
 <!-- badges: end -->
 
@@ -38,10 +38,10 @@ This package enables to build OPeNDAP (https) URLs given input parameters such a
 <a href="#installation">Installation</a><br> •
 <a href="#get-started">Get started</a><br> •
 <a href="#collections-available-in-modisfast">Data collections
-available</a><br> • <a href="#foundational-framework">Foundational
-framework</a><br> •
+available</a><br> •
 <a href="#manual-testing-of-the-functionality">Manual testing of the
-functionality</a><br> •
+functionality</a><br> • <a href="#foundational-framework">Foundational
+framework</a><br> •
 <a href="#comparison-with-similar-r-packages">Comparison with similar R
 packages</a><br> • <a href="#citation">Citation</a><br> •
 <a href="#future-developments">Future developments</a><br> •
@@ -1380,6 +1380,21 @@ Rainfall
 </p>
 </details>
 
+## Manual testing of the functionality
+
+Since most `modisfast` functions depend on EarthData credentials,
+automated tests are disabled. However, after installation, users can
+manually test the package’s functionality by running these lines of code
+:
+
+``` r
+# replace "username" and "password" with your own EOSDIS (Earthdata) credentials 
+earthdata_un <- "username" 
+earthdata_pw <- "password"
+
+devtools::test("modisfast")
+```
+
 ## Foundational framework
 
 Technically, `modisfast` is a programmatic interface (R wrapper) to
@@ -1425,21 +1440,6 @@ downloading the data using the
 [`httr`](https://cran.r-project.org/package=httr) and `parallel`
 packages.
 
-## Manual testing of the functionality
-
-Since most `modisfast` functions depend on EarthData credentials,
-automated tests are disabled. However, after installation, users can
-manually test the package’s functionality by running these lines of code
-:
-
-``` r
-# replace "username" and "password" with your own EOSDIS (Earthdata) credentials 
-earthdata_un <- "username" 
-earthdata_pw <- "password"
-
-devtools::test("modisfast")
-```
-
 ## Comparison with similar R packages
 
 There are other R packages available for accessing MODIS data. Below is

vignettes/articles/get_started.Rmd

@@ -160,11 +160,13 @@ These issues can easily be dealt at the import phase in R using the function `mf
 # import MOD11A1.061
 # argument 'path' is the folder where the data are stored (here, in a temporary directory)
 modis_ts <- mf_import_data(path = dirname(list.files(path = tempdir(), pattern = "MOD13A3.061", recursive = TRUE, full.names = TRUE)),
-                           collection = "MOD13A3.061")
+                           collection = "MOD13A3.061",
+                           proj_epsg = 4326)
 
 # import GPM
 gpm_ts <- mf_import_data(path = unique(dirname(list.files(path = tempdir(), pattern = "3IMERG", recursive = TRUE, full.names = TRUE))),
-                         collection = "GPM_3IMERGM.07")
+                         collection = "GPM_3IMERGM.07",
+                         proj_epsg = 4326)
 
 modis_ts
 gpm_ts