Skip to content

Commit 50535f8

Browse files
authored
Update README.md
1 parent 695d1b7 commit 50535f8

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@
88
<br>
99
</h1>
1010

11-
<h4 align="center">High-level functions to process spatial and simple Earth Engine objects. Popular Third-party GEE algorithms are re-coded from Javascript and Python to R.</h4>
11+
<h4 align="center">
12+
Simplifies the interaction with GEE APIs and functions, making it more R-like. Popular third-party GEE algorithms are
13+
made available to R users
14+
</h4>
1215

1316

1417
<p align="center">
@@ -27,11 +30,10 @@ developed."></a>
2730
status"></a>
2831
<a href="https://doi.org/10.5281/zenodo.3945409"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.3945409.svg" alt="DOI"></a>
2932
<br>
30-
<a href="https://www.buymeacoffee.com/csay" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
33+
<a href="https://github.com/r-earthengine/rgeeExtra/actions/workflows/R-CMD-check.yaml"><img src="https://github.com/r-earthengine/rgeeExtra/actions/workflows/R-CMD-check.yaml/badge.svg" alt="" width="200"></a>
3134
</p>
3235

3336

34-
3537
<p align="center">
3638
3739
<a href="#installation">Installation</a> &nbsp;
@@ -42,9 +44,15 @@ status"></a>
4244
<a href="#credits">Credits</a>
4345
</p>
4446

45-
## What is Google Earth Engine?
47+
## Why rgeeExtra is needed?
48+
49+
The goal of rgeeExtra is to improve the user-friendliness of Google Earth Engine (GEE) by
50+
simplifying its syntax and enhancing the experience for R users. GEE primarily utilizes JavaScript
51+
for its API, which can be quite different from the R programming language. "rgeeExtra" can bridge
52+
this gap by providing R users with a set of functions and tools that abstract the intricacies
53+
of GEE's JavaScript syntax. This extension provides R users with higher-level abstractions and
54+
custom functions that have been reworked from the JavaScript API.
4655

47-
[Google Earth Engine](https://earthengine.google.com/) is a cloud-based platform that allows users to have an easy access to a petabyte-scale archive of remote sensing data and run geospatial analysis on Google's infrastructure. Currently, Google offers support only for Python and JavaScript. `rgee` will fill the gap **starting to provide support to R!**. Below you will find the comparison between the syntax of `rgee` and the two Google-supported client libraries.
4856

4957
<table>
5058
<tr>
@@ -102,21 +110,18 @@ You can install rgeeExtra from [GitHub](https://github.com/r-earthengine/rgeeExt
102110
remotes::install_github("r-earthengine/rgeeExtra")
103111
```
104112

105-
To install Python dependencies, please refer to the installation guidelines provided in the [rgee](https://github.com/r-spatial/rgee#installation)
106-
section of the documentation.
107-
108113
## How does it work?
109114

110115
The rgeeExtra extends the following Earth Engine classes:
111116

112-
- [ee.Feature](https://developers.google.com/earth-engine/guides/features)
113-
- [ee.FeatureCollection](https://developers.google.com/earth-engine/guides/feature_collections)
114-
- [ee.Geometry](https://developers.google.com/earth-engine/guides/geometries)
115-
- [ee.Image](https://developers.google.com/earth-engine/guides/image_overview)
116-
- [ee.ImageCollection](https://developers.google.com/earth-engine/guides/ic_creating)
117+
- [ee$Feature](https://developers.google.com/earth-engine/guides/features)
118+
- [ee$FeatureCollection](https://developers.google.com/earth-engine/guides/feature_collections)
119+
- [ee$Geometry](https://developers.google.com/earth-engine/guides/geometries)
120+
- [ee$Image](https://developers.google.com/earth-engine/guides/image_overview)
121+
- [ee$ImageCollection](https://developers.google.com/earth-engine/guides/ic_creating)
117122

118-
rgeeExtra develops and maintains new methods and constructors that extents the most popular GEE classes (See ee$Extra$...). Besides, it supports functional programming (FP) style to make R users feel more comfortable with the API.
119123

124+
rgeeExtra develops and maintains new methods and constructors that extend the most popular GEE classes (e.g., ee$Feature$Extra_...). All third-party methods implemented by rgeeExtra start with 'Extra_.' To learn more about all the functionalities that rgeeExtra offers, please refer to the article [Features] for additional information.
120125

121126
## Example
122127

0 commit comments

Comments
 (0)