Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ptaconet committed Nov 19, 2024
1 parent f5d714f commit 85afe5f
Show file tree
Hide file tree
Showing 4 changed files with 1,443 additions and 1,438 deletions.
20 changes: 4 additions & 16 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,14 @@

## Breaking changes

* adding unit tests to test the functionality of the package
(see file test/testthat.R) (#11, #15).
* `mf_modisfast()` : new function which enables to execute the whole workflow
(login, get URL, download data, and eventually import data) at a glance.

## New features

* adding three modes for verbose mode : quiet, inform, debug (#13).
* using the `cli` package for textual outputs in verbose mode.

## Minor improvements and fixes

* `mf_get_url()` and `mf_download_data()` : including information on maximum
file size expected (when verbose).
* `mf_import_data()` : default projection now set to source projection of the data.
* `mf_import_data()` : `collection_source` renamed `collection`.
* solving an issue with tile merging at extreme latitude.
* slight modifications in the Contributing.md file (#8).
* slight modifications in the vignettes (#13)
* improve comments in verbose mode


* more details on the error messages (e.g. when wrong ROI is proposed)
* add a start up message when the package is loaded with invitation to cite
package in publication
* fixing bug in time extent for some collections (#18)

19 changes: 12 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ always_allow_html: yes

<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r include=FALSE}
knitr::opts_chunk$set(
fig.path = "man/figures/README-",
out.width = "100%"
)
library(magrittr)
library(modisfast)
library(dplyr)
library(kableExtra)
library(knitr)
knitr::opts_chunk$set(
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# modisfast
<!-- <img src="man/figures/logo.png" align="right" /> -->
Expand Down Expand Up @@ -59,6 +61,10 @@ This package enables to build OPeNDAP (https) URLs given input parameters such a
• <a href="#acknowledgments">Acknowledgments</a><br>
</p>

## News

`modisfast 1.0.0` now [available on CRAN](https://cran.r-project.org/package=modisfast), and [associated software paper](https://doi.org/10.21105/joss.07343) published in the Journal of Open Source Software !

## Overview

**`modisfast`** is an R package designed for **easy** and **fast** downloads of [**MODIS**](https://lpdaac.usgs.gov/data/get-started-data/collection-overview/missions/modis-overview/) Land products, [**VIIRS**](https://lpdaac.usgs.gov/data/get-started-data/collection-overview/missions/s-npp-nasa-viirs-overview/) Land products, and [**GPM**](https://gpm.nasa.gov/data) (Global Precipitation Measurement Mission) Earth Observation data.
Expand Down Expand Up @@ -198,13 +204,13 @@ fun_display_coll <- function(filts){
}
cols_natures <- unique(mf_list_collections()$nature)
cols_natures <- sort(unique(mf_list_collections()$nature))
```


```{r, eval = TRUE, echo=F, message=F, results='asis'}
for(i in 1:length(cols_natures)){
for(i in seq_along(cols_natures)){
if(i==1){
cat('<details><summary><b>',cols_natures[i],'</b> data collections <b>(click to expand)</b></summary>')
} else {
Expand All @@ -213,7 +219,6 @@ for(i in 1:length(cols_natures)){
cat(knitr::asis_output(fun_display_coll(cols_natures[i])))
cat('</details>')
}
```


Expand Down
Loading

0 comments on commit 85afe5f

Please sign in to comment.