Skip to content

Commit 3fa5350

Browse files
committed
update readme and comments for CRAN submission
1 parent 7fee352 commit 3fa5350

File tree

3 files changed

+1431
-69
lines changed

3 files changed

+1431
-69
lines changed

README.Rmd

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,6 @@ knitr::opts_chunk$set(
3030
<!-- [![DOI-zenodo](https://zenodo.org/badge/doi/10.5281/zenodo.8475.svg)](https://doi.org/10.5281/zenodo.12772739) -->
3131
<!-- badges: end -->
3232

33-
<!-- ATTENTION A CHANGER : FUSEAUX HORAIRES POUR DONNEES GPM HALF HOURLY !!!!!!
34-
AUSSI : min filesize (le fichier peut etre plus petit que 50 k.. e.g. titi)
35-
renvoyer erreur ou warning si le fichier n'existe pas
36-
-->
37-
38-
<!-- `r emo::ji("warning")` Package still under development ! -->
39-
40-
<!--
41-
R package to access various spatiotemporal Earth science data collections in R using the [OPeNDAP framework](https://www.opendap.org/about/). Currently implemented data collections are [MODIS](https://lpdaac.usgs.gov/data/get-started-data/collection-overview/missions/modis-overview/), [VIIRS](https://lpdaac.usgs.gov/data/get-started-data/collection-overview/missions/s-npp-nasa-viirs-overview/), [GPM](https://pmm.nasa.gov/GPM) and [SMAP](https://smap.jpl.nasa.gov/)).
42-
Opendap (*Open-source Project for a Network Data Access Protocol*) is a data access protocol that enables to subset the data - spatially, temporally, etc. - directly at the downloading phase. Filters are provided directly within a http url. For example the following URL :
43-
https://opendap.cr.usgs.gov/opendap/hyrax/MOD11A1.006/h17v08.ncml.nc4?MODIS_Grid_Daily_1km_LST_eos_cf_projection,LST_Day_1km[6093:6122][55:140][512:560],LST_Night_1km[6093:6122][55:140][512:560],QC_Day[6093:6122][55:140][512:560],QC_Night[6093:6122][55:140][512:560],time[6093:6122],YDim[55:140],XDim[512:560]
44-
provides the MOD11A1.006 (MODIS/Terra Land Surface Temperature/Emissivity Daily L3 Global 1km SIN Grid V006) data in netCDF, subsetted for bands LST_Day_1km, LST_Night_1km, QC_Day, QC_Night, for each day between the 2017-01-01 and the 2017-01-30, and within the following bounding box (lon/lat): -5.41 8.84, -5.82 9.54.
45-
This package enables to build OPeNDAP (https) URLs given input parameters such as a data collection, region and time range of interst . These URLs can then be used to either download the data to your workspace or computer, or access the datacube directly as an R object (of class `ndcf4`, `raster`, `stars`, etc.)
46-
-->
4733

4834
## Table of contents
4935

@@ -67,7 +53,7 @@ This package enables to build OPeNDAP (https) URLs given input parameters such a
6753

6854
## Overview
6955

70-
**`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.
56+
**`modisfast`** is an R package designed for **easy** and **fast** downloads of [**MODIS**](https://www.earthdata.nasa.gov/data/instruments/modis) Land products, [**VIIRS**](https://www.earthdata.nasa.gov/data/instruments/viirs) Land products, and [**GPM**](https://gpm.nasa.gov/data) (Global Precipitation Measurement Mission) Earth Observation data.
7157

7258
`modisfast` uses the abilities offered by the [OPeNDAP](https://www.opendap.org/about/) framework (*Open-source Project for a Network Data Access Protocol*) to download a subset of Earth Observation data cube, along spatial, temporal or any other data dimension (depth, ...). This way, it reduces downloading time and disk usage to their minimum : no more 1° x 1° MODIS tiles with 10 bands when your region of interest is only 30 km x 30 km wide and you need 2 bands ! Moreover, `modisfast` enables parallel downloads of data.
7359

@@ -176,8 +162,8 @@ We thank in advance people that use `modisfast` for citing it in their work / pu
176162

177163
Currently `modisfast` supports download of `r nrow(mf_list_collections())` data collections, extracted from the following meta-collections :
178164

179-
* [MODIS land products](https://lpdaac.usgs.gov/data/get-started-data/collection-overview/missions/modis-overview/) made available by the [NASA / USGS LP DAAC](https://lpdaac.usgs.gov/) ( :arrow_right: [source OPeNDAP server](https://opendap.cr.usgs.gov/opendap/hyrax/)) ;
180-
* [VIIRS land products](https://lpdaac.usgs.gov/data/get-started-data/collection-overview/missions/s-npp-nasa-viirs-overview/) made available by the [NASA / USGS LP DAAC](https://lpdaac.usgs.gov/) ( :arrow_right: [source OPeNDAP server](https://opendap.cr.usgs.gov/opendap/hyrax/))
165+
* [MODIS land products](https://www.earthdata.nasa.gov/data/instruments/modis) made available by the [NASA / USGS LP DAAC](https://www.earthdata.nasa.gov/centers/lp-daac) ( :arrow_right: [source OPeNDAP server](https://opendap.cr.usgs.gov/opendap/hyrax/)) ;
166+
* [VIIRS land products](https://www.earthdata.nasa.gov/data/instruments/viirs) made available by the [NASA / USGS LP DAAC](https://www.earthdata.nasa.gov/centers/lp-daac) ( :arrow_right: [source OPeNDAP server](https://opendap.cr.usgs.gov/opendap/hyrax/))
181167
* [Global Precipitation Measurement](https://gpm.nasa.gov/missions/GPM) (GPM) made available by the [NASA / JAXA GES DISC](https://disc.gsfc.nasa.gov/) ( :arrow_right: [source OPeNDAP server](https://gpm1.gesdisc.eosdis.nasa.gov/opendap/hyrax/GPM_L3/)).
182168

183169
Details of each product available for download are provided in the tables below or through the function `mf_list_collections()`.

0 commit comments

Comments
 (0)