rsat

Dealing with Multiplatform Satellite Images from Landsat, MODIS, and Sentinel.
https://github.com/ropensci/rsat

satellite-images

Last synced: about 7 hours ago
JSON representation

Repository metadata

Dealing with Multiplatform Satellite Images from Landsat, MODIS, and Sentinel

• Host: GitHub
• URL: https://github.com/ropensci/rsat
• Owner: ropensci
• License: gpl-3.0
• Created: 2020-06-19T09:19:22.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-18T12:33:00.000Z (23 days ago)
• Last Synced: 2024-05-09T06:03:18.283Z (2 days ago)
• Topics: satellite-images
• Language: R
• Homepage: https://docs.ropensci.org/rsat/
• Size: 12.4 MB
• Stars: 49
• Watchers: 5
• Forks: 3
• Open Issues: 7
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE.md
  • Codemeta: codemeta.json

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# rsat

[![CRAN version](https://www.r-pkg.org/badges/version/rsat)](https://CRAN.R-project.org/package=rsat)  

[![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/437_status.svg)](https://github.com/ropensci/software-review/issues/437)

[![Lifecycle:maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html)

[![Codecov test coverage](https://codecov.io/gh/ropensci/rsat/branch/master/graph/badge.svg)](https://app.codecov.io/gh/ropensci/rsat?branch=master)

[![R build status](https://github.com/ropensci/rsat/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/rsat/actions)

[![Total downloads](https://cranlogs.r-pkg.org/badges/grand-total/rsat)](https://CRAN.R-project.org/package=rsat)

The goal of `rsat` is to help you handling time-series of satellite images from multiple platforms in a local, efficient, and standardized way. The package provides tools to;

1.  Search (run `vignette("rsat1_search", package = "rsat")`)

2.  Download (run `vignette("rsat2_download", package = "rsat")`)

3.  Customize, and (run `vignette("rsat3_customize", package = "rsat")`)

4.  Process (run `vignette("rsat4_process", package = "rsat")`)

satellite images from Landsat, MODIS, and Sentinel for a region and time of interest.

## Installation

You can install the development version from [GitHub](https://github.com/) with:

``` r

install.packages(c('usethis', 'pkgdown', 'rcmdcheck', 'rversions', 'urlchecker'))

# check and install devtools

if(!require("devtools")){

   install.packages("devtools")

}

# check and install rmarkdown

if(!require("rmarkdown")){

  install.packages("rmarkdown")

}

devtools::install_github("spatialstatisticsupna/rsat", build_vignettes=TRUE)

```

### Linux

In Linux, you need to install additional libraries before starting with `rsat`. Use the following commands for:

-   **Debian/Ubuntu**

    sudo apt install r-cran-rcpp gdal-bin libgdal-dev libproj-dev openssl libssl-dev xml2 libxml2-dev libmagick++-dev libfreetype6-dev libpng-dev libtiff5-dev libjpeg-dev libharfbuzz-dev libfribidi-dev

-   **RedHat/Fedora**

    sudo dnf install gdal gdal-devel proj-devel xml2 libxml2-devel libcurl-devel openssl-devel ImageMagick-c++-devel R-devel udunits2-devel sqlite-devel geos-devel pandoc harfbuzz-devel fribidi-devel freetype-devel libpng-devel libtiff-devel libjpeg-devel

## Log-in profiles

The registration in the following online portals is required to get a full access to satellite images with `rsat`;

-   [USGS](https://ers.cr.usgs.gov/register/) USGS is the sole science agency for the Department of the Interior of United States. Provide access to Modis Images. More information about USGS can be found [Here](https://www.usgs.gov/).

-   [EarthData](https://urs.earthdata.nasa.gov): A repository of NASA's earth observation data-sets. More information about EarthData can be found [here](https://www.earthdata.nasa.gov/learn).

-   [Dataspace](https://dataspace.copernicus.eu/), a web service giving access to Copernicus' scientific data hub. Please go [here](https://dataspace.copernicus.eu/) to find more details about the data hub.

For convenience, try to use the same username and password for all of them. To satisfy the criteria of all web services make sure that the username is $4$ characters long and includes a period, number or underscore. The password must be $12$ character long and should include characters with at least one capital letter, and numbers.

## Example

This is a basic example which shows you how to compute the Normalized Difference Vegetation Index from a MODIS image captured on January 11th, 2020 in northern Spain (Navarre):

``` r

library(rsat)

# replace with your own "username" and "password"

set_credentials("username", "password")

# region and time of interest: rtoi

roi <- ex.navarre

toi <- as.Date("2020-01-11")

rtp <- tempdir()

set_database(file.path(tempdir(), "DATABASE"))

navarre <- new_rtoi("Navarre", roi, rtp)

# search, acquire, customize, and process

rsat_search(region = navarre, product = "mod09ga", dates = toi)

rsat_download(navarre)

rsat_mosaic(navarre, overwrite = TRUE)

rsat_derive(navarre, 

            product = "mod09ga", 

            variable = "NDVI")

# plot the results

plot(navarre, "view" , 

      product = "mod09ga", 

      variable = "NDVI", 

      breaks = seq(0, 1, 0.1))

      

plot(navarre,"dates")

```

See the vignettes for more examples:

```

browseVignettes("rsat")

```

## Related similar packages

R has become an outstanding tool for remote sensing image analysis.

There are several tools for the search and acquisition of satellite

images, however, rsat is the first package that standardizes all the

procedures in data acquisition to provide an unique workflow for any

multispectral satellite.

Currently there are several packages dedicated to remote sensing topic,

but they are usually ad-hoc packages for each satellite. Here is a list

of some of the most popular R packages dedicated to satellite imagery:

### Multi satellite packages

-   [RGISTools](https://github.com/spatialstatisticsupna/RGISTools)

-   [getSpatialData](https://github.com/16EAGLE/getSpatialData)

-   [luna](https://github.com/rspatial/luna)

The closest package to `rsat` is RGISTools. `rsat` is the redefinition

of the RGISTools package reprogrammed from scrach in the object-oriented

programming paradigm. Many of the RGISTools code lines have been used to

develop `rsat`, but these have been optimized and redundancies in the

code have been removed in order to facilitate its maintenance. In

addition, `rsat` contains new features and R classes to make it more

user-friendly.

`getSpatialData` is another package very similar to `rsat`. The package

has the same philosophy of having a single package for searching and

downloading satellite images. However, the development of `rsat` goes a

bit further and in addition to search and download, the package helps

you to organize all the downloaded information in a structured database.

`rsat` allows you to use the metadata of the images to see the direct

relation with your region of interest before downloading it. Also all

image processing standardization is not developed in `getSpatialData`.

The last package dedicated to image downloading is `luna`.Searching and

downloading images compared to rsat is a bit more complicated. It is

only able to search and download Modis and Landsat images, and does not

help you in organizing the image products.

### Single satellite packages

-   [rLandsat](https://github.com/atlanhq/rLandsat)

-   [getLandsat](https://github.com/ropensci-archive/getlandsat)

-   [sen2r](https://github.com/ranghetti/sen2r)

`rLandsat` makes it easy to search for Landsat8 product IDs, place an

order on USGS-ESPA and download the data. `rsat` on the other hand is

able to do the image search without knowing all the ids, just using a

polygon of the region of interest, making the search process much

easier.

`getlandsat` provides access to Landsat 8 metadata and images hosted on

AWS S3 at. The package only data for the users, and does not help in

further use, as rsat does.

`sen2r` is an R library which helps to download and preprocess

Sentinel-2 optical images. This is done through a GUI, something that

can be very interesting for users but limits the analysis of the

information prior to downloading, which can be done with `rsat`.

### Raster processing packages

-   [landsat](https://cran.r-project.org/web/packages/landsat/index.html)

-   [satellite](https://github.com/environmentalinformatics-marburg/satellite)

-   [OpenImageR](https://github.com/mlampros/OpenImageR)

-   [RSToolbox](https://github.com/bleutner/RStoolbox)

-   [sits](https://github.com/e-sensing/sits)

`rsat` helps you to search, download and pre-process the images, but

once these procedures are done it allows you to extract all the

processed information into the most used raster classes in R (`raster`,

`stars` or `spatRaster`). The image processing packages can be used for

further analysis in these R classes.

## Contributing

We accept contributions to improve the package. Before contributing, please follow these steps:

-    Contributions should be thoroughly tested with testthat.

-    Code style should attempt to follow the tidyverse style guide.

-    Please attempt to describe what you want to do prior to contributing by submitting an issue.

-    Please follow the typical github fork - pull-request workflow.

-    Make sure you use roxygen and run Check before contributing. More on this front as the package matures.

## Code of conduct

Please note that this package is released with a [Contributor

Code of Conduct](https://ropensci.org/code-of-conduct/). 

By

contributing to this project, you agree to abide by its terms.

## Citation

``` r

citation("rsat")[1]

```

To cite the package:

U. Pérez-Goya, M. Montesino-SanMartin, A F Militino, M D Ugarte (2021). rsat: Dealing with Multiplatform Satellite Images from Landsat, MODIS, and Sentinel. R package version 0.1.16. .

## Acknowledgements

This work has been financed by projects MTM2017-82553-R (AEI/FEDER, UE) and PID2020-113125RB-I00/MCIN/AEI/10.13039/501100011033.
      

---

Owner metadata

• Name: rOpenSci
• Login: ropensci
• Email: [email protected]
• Kind: organization
• Description:
• Website: https://ropensci.org/
• Location: Berkeley, CA
• Twitter: rOpenSci
• Company:
• Icon url: https://avatars.githubusercontent.com/u/1200269?v=4
• Repositories: 307
• Last ynced at: 2023-03-10T20:30:59.242Z
• Profile URL: https://github.com/ropensci

---

GitHub Events

Total

• Issues event: 16
• Watch event: 39
• Member event: 1
• Issue comment event: 10
• Push event: 52
• Pull request event: 4
• Fork event: 5
• Create event: 1

Last Year

• Fork event: 3
• Issue comment event: 4
• Issues event: 6
• Pull request event: 2
• Push event: 16
• Watch event: 12

---

Committers metadata

Last synced: 1 day ago

Name	Email	Commits
unai-perez	u****z@u****s	342
mmontesinosanmartin	m****a@g****m	21
Ugaitz Amozarrain	u****n@u****s	15
MANUEL MONTESINO SAN MARTIN	m****o@d****s	12
Manuel Montesino-SanMartín	5****n	6
Ugaitz Amozarrain	u****n@g****m	5
HARKAITZ GOYENA BAROJA	h****a@u****s	1
Maëlle Salmon	m****n@y****e	1
olivroy	5****y	1

Committer domains:

• unavarra.es: 3
• dyc.a.unavarra.es: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/ropensci/rsat

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • cran: 211 last-month
• Total dependent packages: 0
• Total dependent repositories: 0
• Total versions: 3
• Total maintainers: 1

---

Dependencies

Score: 11.579162542743381