From dc016d9d33328159a82bca5f5e0b256c06f1e6dd Mon Sep 17 00:00:00 2001 From: ambarja Date: Fri, 2 Aug 2024 17:20:13 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20r-spatia?= =?UTF-8?q?l/rgee@483658e8d399abdc74bf8a5b66d870244eecd679=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 28 +- CODE_OF_CONDUCT.html | 26 +- CONTRIBUTING.html | 24 +- ISSUE_TEMPLATE.html | 24 +- LICENSE.html | 24 +- articles/index.html | 24 +- articles/rgee01.html | 36 +- articles/rgee02.html | 32 +- articles/rgee03.html | 36 +- articles/rgee04.html | 36 +- articles/rgee05.html | 36 +- articles/rgee06.html | 36 +- authors.html | 54 +-- index.html | 28 +- news/index.html | 28 +- pkgdown.yml | 5 +- reference/+.EarthEngineMap.html | 8 + reference/EarthEngineMap,.html | 8 + reference/EarthEngineMap-method.html | 8 + reference/Map.html | 34 +- reference/R6Map.html | 60 ++-- reference/ee.html | 30 +- reference/ee_Authenticate.html | 54 +-- reference/ee_Initialize.html | 64 ++-- reference/ee_as_rast.html | 66 ++-- reference/ee_as_raster.html | 64 ++-- reference/ee_as_sf.html | 62 ++-- reference/ee_as_stars.html | 66 ++-- reference/ee_as_thumbnail.html | 50 +-- reference/ee_check-tools.html | 40 +-- reference/ee_check.html | 8 + reference/ee_check_credentials.html | 8 + reference/ee_check_gcloud.html | 8 + reference/ee_check_python.html | 8 + reference/ee_check_python_packages.html | 8 + reference/ee_check_task_status.html | 8 + reference/ee_clean_container.html | 40 +-- reference/ee_clean_pyenv.html | 36 +- reference/ee_clean_user_credentials.html | 48 ++- reference/ee_drive_to_local.html | 52 +-- reference/ee_extract.html | 56 +-- reference/ee_gcs_to_local.html | 50 +-- reference/ee_get_assethome.html | 36 +- reference/ee_get_date_ic.html | 42 +-- reference/ee_get_date_img.html | 42 +-- reference/ee_get_earthengine_path.html | 32 +- reference/ee_help.html | 42 +-- reference/ee_image_info.html | 46 +-- reference/ee_image_to_asset.html | 60 ++-- reference/ee_image_to_drive.html | 72 ++-- reference/ee_image_to_gcs.html | 70 ++-- reference/ee_imagecollection_to_local.html | 64 ++-- reference/ee_install.html | 46 +-- reference/ee_install_set_pyenv.html | 48 +-- reference/ee_install_upgrade.html | 42 +-- reference/ee_manage-tools.html | 56 +-- reference/ee_manage_asset_access.html | 8 + reference/ee_manage_asset_size.html | 8 + reference/ee_manage_assetlist.html | 8 + .../ee_manage_cancel_all_running_task.html | 8 + reference/ee_manage_copy.html | 8 + reference/ee_manage_create.html | 8 + reference/ee_manage_delete.html | 8 + reference/ee_manage_delete_properties.html | 8 + reference/ee_manage_move.html | 8 + reference/ee_manage_quota.html | 8 + reference/ee_manage_set_properties.html | 8 + reference/ee_manage_task.html | 8 + reference/ee_monitoring.html | 48 +-- reference/ee_print.ee.feature.Feature.html | 8 + ...e.featurecollection.FeatureCollection.html | 8 + reference/ee_print.ee.geometry.Geometry.html | 8 + reference/ee_print.ee.image.Image.html | 8 + ...nt.ee.imagecollection.ImageCollection.html | 8 + reference/ee_print.html | 66 ++-- reference/ee_table_to_asset.html | 46 +-- reference/ee_table_to_drive.html | 52 +-- reference/ee_table_to_gcs.html | 52 +-- reference/ee_user_info.html | 40 +-- reference/ee_users.html | 40 +-- reference/ee_utils_cog_metadata.html | 42 +-- reference/ee_utils_create_json.html | 38 +-- reference/ee_utils_create_manifest_image.html | 54 +-- reference/ee_utils_create_manifest_table.html | 52 +-- reference/ee_utils_dataset_display.html | 38 +-- reference/ee_utils_future_value.html | 44 ++- reference/ee_utils_get_crs.html | 38 +-- reference/ee_utils_py_to_r.html | 36 +- reference/ee_utils_pyfunc.html | 40 +-- reference/ee_utils_sak_copy.html | 40 +-- reference/ee_utils_sak_validate.html | 38 ++- reference/ee_utils_shp_to_zip.html | 44 +-- reference/ee_version.html | 32 +- reference/eedate_to_rdate.html | 42 +-- reference/gcs_to_ee_image.html | 44 +-- reference/gcs_to_ee_table.html | 44 +-- reference/index.html | 24 +- reference/local_to_gcs.html | 46 +-- reference/map-operator.html | 42 +-- reference/pipe.html | 26 +- ...rint.ee.computedobject.ComputedObject.html | 40 +-- reference/print.html | 8 + reference/raster_as_ee.html | 56 +-- reference/rdate_to_eedate.html | 42 +-- reference/rgee-package.html | 96 +++--- reference/rgee.html | 8 + reference/sf_as_ee.html | 64 ++-- reference/stars_as_ee.html | 56 +-- sitemap.xml | 320 +++++------------- 109 files changed, 2040 insertions(+), 2053 deletions(-) create mode 100644 reference/+.EarthEngineMap.html create mode 100644 reference/EarthEngineMap,.html create mode 100644 reference/EarthEngineMap-method.html create mode 100644 reference/ee_check.html create mode 100644 reference/ee_check_credentials.html create mode 100644 reference/ee_check_gcloud.html create mode 100644 reference/ee_check_python.html create mode 100644 reference/ee_check_python_packages.html create mode 100644 reference/ee_check_task_status.html create mode 100644 reference/ee_manage_asset_access.html create mode 100644 reference/ee_manage_asset_size.html create mode 100644 reference/ee_manage_assetlist.html create mode 100644 reference/ee_manage_cancel_all_running_task.html create mode 100644 reference/ee_manage_copy.html create mode 100644 reference/ee_manage_create.html create mode 100644 reference/ee_manage_delete.html create mode 100644 reference/ee_manage_delete_properties.html create mode 100644 reference/ee_manage_move.html create mode 100644 reference/ee_manage_quota.html create mode 100644 reference/ee_manage_set_properties.html create mode 100644 reference/ee_manage_task.html create mode 100644 reference/ee_print.ee.feature.Feature.html create mode 100644 reference/ee_print.ee.featurecollection.FeatureCollection.html create mode 100644 reference/ee_print.ee.geometry.Geometry.html create mode 100644 reference/ee_print.ee.image.Image.html create mode 100644 reference/ee_print.ee.imagecollection.ImageCollection.html create mode 100644 reference/print.html create mode 100644 reference/rgee.html diff --git a/404.html b/404.html index 6e9aba53..0c80a01f 100644 --- a/404.html +++ b/404.html @@ -6,12 +6,6 @@ Page not found (404) • rgee - - - - - - @@ -25,7 +19,7 @@ - +
- +
@@ -142,16 +136,16 @@

Page not found (404)

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/CODE_OF_CONDUCT.html b/CODE_OF_CONDUCT.html index b7a29e52..4eb6cc85 100644 --- a/CODE_OF_CONDUCT.html +++ b/CODE_OF_CONDUCT.html @@ -1,9 +1,9 @@ -Contributor Covenant Code of Conduct • rgeeContributor Covenant Code of Conduct • rgee - +
- +
@@ -93,7 +93,7 @@

Contributor Covenant Code of Conduct

-

Our Pledge

@@ -150,15 +150,15 @@

Attribution -

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html index 757a4816..85c9a381 100644 --- a/CONTRIBUTING.html +++ b/CONTRIBUTING.html @@ -1,9 +1,9 @@ -Contributing to rgee • rgeeContributing to rgee • rgee - +
- +
@@ -179,15 +179,15 @@

Development guidelines
-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/ISSUE_TEMPLATE.html b/ISSUE_TEMPLATE.html index 52b1739f..5e9f1c4f 100644 --- a/ISSUE_TEMPLATE.html +++ b/ISSUE_TEMPLATE.html @@ -1,9 +1,9 @@ -NA • rgeeNA • rgee - +
- +
@@ -144,15 +144,15 @@

What I Did -

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/LICENSE.html b/LICENSE.html index 3c3d2a35..3155603b 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -1,9 +1,9 @@ -Apache License • rgeeApache License • rgee - +
- +
@@ -186,15 +186,15 @@

APPENDIX: How to

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/articles/index.html b/articles/index.html index 6c7808c1..d43226ad 100644 --- a/articles/index.html +++ b/articles/index.html @@ -1,9 +1,9 @@ -Articles • rgeeArticles • rgee - +
- +
@@ -117,15 +117,15 @@

All vignettes

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/articles/rgee01.html b/articles/rgee01.html index 7ce01044..1b443787 100644 --- a/articles/rgee01.html +++ b/articles/rgee01.html @@ -6,27 +6,19 @@ Introduction to rgee • rgee - - - - - - - - - +
- +
@@ -123,7 +115,7 @@

Introduction to rgee

- Source: vignettes/rgee01.Rmd + Source: vignettes/rgee01.Rmd
@@ -417,9 +409,7 @@

9. Checking - -

+
@@ -432,16 +422,16 @@

9. Checking

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/articles/rgee02.html b/articles/rgee02.html index 143a0044..4b3d11bd 100644 --- a/articles/rgee02.html +++ b/articles/rgee02.html @@ -6,27 +6,19 @@ Considerations • rgee - - - - - - - - - +
- +
@@ -123,7 +115,7 @@

Considerations

- Source: vignettes/rgee02.Rmd + Source: vignettes/rgee02.Rmd
@@ -317,16 +309,16 @@

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/articles/rgee03.html b/articles/rgee03.html index 9f4b5d74..232fbd6c 100644 --- a/articles/rgee03.html +++ b/articles/rgee03.html @@ -6,27 +6,19 @@ Best Practices • rgee - - - - - - - - - +
- +
@@ -123,7 +115,7 @@

Best Practices

- Source: vignettes/rgee03.Rmd + Source: vignettes/rgee03.Rmd
@@ -1174,9 +1166,7 @@

+

@@ -1189,16 +1179,16 @@

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/articles/rgee04.html b/articles/rgee04.html index 56ac2144..b664c61d 100644 --- a/articles/rgee04.html +++ b/articles/rgee04.html @@ -6,27 +6,19 @@ How to create and deploy rgee Shiny apps - I • rgee - - - - - - - - - +
- +
@@ -124,7 +116,7 @@

How to create and deploy rgee Shiny apps - I

- Source: vignettes/rgee04.Rmd + Source: vignettes/rgee04.Rmd
@@ -259,9 +251,7 @@

+

@@ -274,16 +264,16 @@

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/articles/rgee05.html b/articles/rgee05.html index dfd04a4d..f80eaab8 100644 --- a/articles/rgee05.html +++ b/articles/rgee05.html @@ -6,27 +6,19 @@ Integrate Google Cloud Storage and rgee • rgee - - - - - - - - - +
- +
@@ -123,7 +115,7 @@

Integrate Google Cloud Storage and rgee

- Source: vignettes/rgee05.Rmd + Source: vignettes/rgee05.Rmd
@@ -470,9 +462,7 @@

+

@@ -485,16 +475,16 @@

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/articles/rgee06.html b/articles/rgee06.html index dd3922c9..777f59d4 100644 --- a/articles/rgee06.html +++ b/articles/rgee06.html @@ -6,27 +6,19 @@ How to integrate Rmarkdown and rgee • rgee - - - - - - - - - +
- +
@@ -123,7 +115,7 @@

How to integrate Rmarkdown and rgee

- Source: vignettes/rgee06.Rmd + Source: vignettes/rgee06.Rmd
@@ -264,9 +256,7 @@

3. Show me the code! - -

+
@@ -279,16 +269,16 @@

3. Show me the code!

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/authors.html b/authors.html index 88e9e957..925b5e90 100644 --- a/authors.html +++ b/authors.html @@ -1,9 +1,9 @@ -Authors and Citation • rgeeAuthors and Citation • rgee - +
- +
@@ -92,7 +92,7 @@

Authors and Citation

- +

  • Cesar Aybar. Author, maintainer.

    @@ -114,7 +114,7 @@

    Authors and Citation

  • -

    Kevin Ushey. Contributor. +

    Kevin Ushey. Contributor.

  • @@ -122,19 +122,19 @@

    Authors and Citation

  • -

    Tim Appelhans. Contributor. +

    Tim Appelhans. Contributor.

  • -

    JJ Allaire. Contributor. +

    JJ Allaire. Contributor.

  • -

    Yuan Tang. Contributor. +

    Yuan Tang. Contributor.

  • -

    Samapriya Roy. Contributor. +

    Samapriya Roy. Contributor.

  • @@ -146,36 +146,36 @@

    Authors and Citation

  • -

    Henrik Bengtsson. Contributor. +

    Henrik Bengtsson. Contributor.

  • -

    Jeffrey Hollister. Reviewer. -
    Hollister reviewed the package for JOSS, see +

    Jeffrey Hollister. Reviewer. +
    Hollister reviewed the package for JOSS, see https://github.com/openjournals/joss-reviews/issues/2272/

  • -

    Gennadii Donchyts. Reviewer. -
    Gena reviewed the package for JOSS, see +

    Gennadii Donchyts. Reviewer. +
    Gena reviewed the package for JOSS, see https://github.com/openjournals/joss-reviews/issues/2272/

  • -

    Marius Appel. Reviewer. -
    Appel reviewed the package for JOSS, see +

    Marius Appel. Reviewer. +
    Appel reviewed the package for JOSS, see https://github.com/openjournals/joss-reviews/issues/2272/

Citation

- Source: DESCRIPTION + Source: DESCRIPTION

Aybar C (2024). rgee: R Bindings for Calling the 'Earth Engine' API. -R package version 1.1.7, https://r-spatial.github.io/rgee/, https://github.com/google/earthengine-api/, https://github.com/r-spatial/rgee/. +R package version 1.1.7, https://r-spatial.github.io/rgee/, https://github.com/google/earthengine-api/, https://github.com/r-spatial/rgee/. 

@Manual{,
   title = {rgee: R Bindings for Calling the 'Earth Engine' API},
@@ -196,15 +196,15 @@ 
Citation

 
 
 

-  
Site built with pkgdown 2.0.9.

+  
Site built with pkgdown 2.1.0.

 

 
       
 
-  
 
 
-  
+
+
 
   
 
diff --git a/index.html b/index.html
index 03351db0..b3292c6f 100644
--- a/index.html
+++ b/index.html
@@ -6,12 +6,6 @@
 
 
 R Bindings for Calling the Earth Engine API • rgee
-
-
-
-
-
-
 
 
 
@@ -26,7 +20,7 @@
 
 
 
-    
+
 
     

       

 
 
-      
+
 
       

   

@@ -592,16 +586,16 @@ 
Dev status

 
 

   

-
Site built with pkgdown 2.0.9.

+
Site built with pkgdown 2.1.0.

 

 
       
 

 
-  
 
 
-  
+
+
 
   
 
diff --git a/news/index.html b/news/index.html
index 9c8b1f64..fad9ea43 100644
--- a/news/index.html
+++ b/news/index.html
@@ -1,9 +1,9 @@
 
-Changelog • rgeeChangelog • rgee
-    
+
 
     

       

 

 
-      
+
 
       

   

     

       
Changelog 

-      Source: NEWS.md
+      Source: NEWS.md
     

 
     

@@ -344,7 +344,7 @@ 
rgee 0.6.0rgee 0.5.4

 
  • Earth Engine Python API updated to 0.1.224.
    • 
 
  • Fix a Map typo.
    • 
-
  • Fix a bug in ee_as_thumbnail, now the vizparams are checked before to pass to eeImagegetThumbURL(…).
    • 
+
  • Fix a bug in ee_as_thumbnail, now the vizparams are checked before to pass to eeImageImagegetThumbURL(…).
    • 
 
  • ee is now an internal rgee environment.
    • 
 
  • ee_reattach was deleted.
    • 
 
  • ee_print now display the ee$Image properties: system:id, system:time_start and system:time_end.
    • 
@@ -421,15 +421,15 @@ 
    rgee 0.5.0
-  
    Site built with pkgdown 2.0.9.
    
+  
    Site built with pkgdown 2.1.0.
    
 

 
       

 
-  
 
 
-  
+
+
 
   
 
diff --git a/pkgdown.yml b/pkgdown.yml
index e67f70e1..1ab12702 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -1,5 +1,5 @@
 pandoc: 3.1.11
-pkgdown: 2.0.9
+pkgdown: 2.1.0
 pkgdown_sha: ~
 articles:
   rgee01: rgee01.html
@@ -8,8 +8,7 @@ articles:
   rgee04: rgee04.html
   rgee05: rgee05.html
   rgee06: rgee06.html
-last_built: 2024-07-04T18:41Z
+last_built: 2024-08-02T17:19Z
 urls:
   reference: https://r-spatial.github.io/rgee/reference
   article: https://r-spatial.github.io/rgee/articles
-
diff --git a/reference/+.EarthEngineMap.html b/reference/+.EarthEngineMap.html
new file mode 100644
index 00000000..b07ace7f
--- /dev/null
+++ b/reference/+.EarthEngineMap.html
@@ -0,0 +1,8 @@
+
+  
+    
+    
+    
+  
+
+
diff --git a/reference/EarthEngineMap,.html b/reference/EarthEngineMap,.html
new file mode 100644
index 00000000..b07ace7f
--- /dev/null
+++ b/reference/EarthEngineMap,.html
@@ -0,0 +1,8 @@
+
+  
+    
+    
+    
+  
+
+
diff --git a/reference/EarthEngineMap-method.html b/reference/EarthEngineMap-method.html
new file mode 100644
index 00000000..b07ace7f
--- /dev/null
+++ b/reference/EarthEngineMap-method.html
@@ -0,0 +1,8 @@
+
+  
+    
+    
+    
+  
+
+
diff --git a/reference/Map.html b/reference/Map.html
index 543bc193..983cb83b 100644
--- a/reference/Map.html
+++ b/reference/Map.html
@@ -1,11 +1,11 @@
 
-R6 object (Map) to display Earth Engine (EE) spatial objects — Map • rgeeR6 object (Map) to display Earth Engine (EE) spatial objects — Map • rgee
-    
+
 
     

       

 

 
-      
+
 
       

   

     

     
R6 object (Map) to display Earth Engine (EE) spatial objects

-    Source: R/R6Map.R
+    Source: R/R6Map.R
     
     

 
@@ -171,9 +171,7 @@ 
Format

 

     

     
Value

-    
-
-
Object of class leaflet, with the following extra parameters: tokens, name,
+    
Object of class leaflet, with the following extra parameters: tokens, name,
 opacity, shown, min, max, palette, and legend. Use the $ method to retrieve
 the data (e.g. m$rgee$min).

     

@@ -208,7 +206,7 @@ 
Details

 
     

     
Examples

-    
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(sf)
 
@@ -284,7 +282,7 @@ 
Examples

 visParams <- list(bands = c("B3", "B2", "B1"), min = 3000, max = 13500, nodata = 0)
 Map$centerObject(resource)
 Map$addLayer(resource, visParams = visParams, shown = TRUE)
-}
+} # }
 

     

   

@@ -299,15 +297,15 @@ 
Examples

 

 
 

-  
Site built with pkgdown 2.0.9.

+  
Site built with pkgdown 2.1.0.

 

 
       

 
-  
 
 
-  
+
+
 
   
 
diff --git a/reference/R6Map.html b/reference/R6Map.html
index b8d07f79..274408b4 100644
--- a/reference/R6Map.html
+++ b/reference/R6Map.html
@@ -1,11 +1,11 @@
 
-R6 class to display Earth Engine (EE) spatial objects — R6Map • rgeeR6 class to display Earth Engine (EE) spatial objects — R6Map • rgee
-    
+
 
     

       

 

 
-      
+
 
       

   

     

     
R6 class to display Earth Engine (EE) spatial objects

-    Source: R/R6Map.R
+    Source: R/R6Map.R
     
     

 
@@ -104,9 +104,7 @@ 
R6 class to display Earth Engine (EE) spatial objects

 
     

     
Value

-    
-
-
Object of class leaflet and EarthEngineMap, with the
+    
Object of class leaflet and EarthEngineMap, with the
 following extra parameters: tokens, name, opacity, shown, min, max, palette,
 position, and legend. Use the $ method to retrieve the data (e.g., m$rgee$min).

     

@@ -170,7 +168,7 @@ 
Public fields

     

     

     
Methods

-    
+
 

 
Public methods

 
@@ -729,7 +727,7 @@ 
Examples

 ## Method `R6Map$reset`
 ## ------------------------------------------------
 
-if (FALSE) {
+if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 
@@ -750,13 +748,13 @@ 
Examples

 
 Map$reset() # Reset arguments
 Map
-}
+} # }
 
 ## ------------------------------------------------
 ## Method `R6Map$setCenter`
 ## ------------------------------------------------
 
-if (FALSE) {
+if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_Initialize()
@@ -768,13 +766,13 @@ 
Examples

 # Map$lat
 # Map$lon
 # Map$zoom
-}
+} # }
 
 ## ------------------------------------------------
 ## Method `R6Map$setZoom`
 ## ------------------------------------------------
 
-if (FALSE) {
+if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_Initialize()
@@ -786,13 +784,13 @@ 
Examples

 # Map$lat
 # Map$lon
 # Map$zoom
-}
+} # }
 
 ## ------------------------------------------------
 ## Method `R6Map$centerObject`
 ## ------------------------------------------------
 
-if (FALSE) {
+if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_Initialize()
@@ -801,13 +799,13 @@ 
Examples

 image <- ee$Image("LANDSAT/LC08/C01/T1/LC08_044034_20140318")
 Map$centerObject(image)
 Map
-}
+} # }
 
 ## ------------------------------------------------
 ## Method `R6Map$addLayer`
 ## ------------------------------------------------
 
-if (FALSE) {
+if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 
@@ -849,13 +847,13 @@ 
Examples

 )
 
 Map$reset()
-}
+} # }
 
 ## ------------------------------------------------
 ## Method `R6Map$addLayers`
 ## ------------------------------------------------
 
-if (FALSE) {
+if (FALSE) { # \dontrun{
 library(sf)
 library(rgee)
 
@@ -879,13 +877,13 @@ 
Examples

 Map$previous_map_right$rgee$tokens
 
 Map$reset()
-}
+} # }
 
 ## ------------------------------------------------
 ## Method `R6Map$addLegend`
 ## ------------------------------------------------
 
-if (FALSE) {
+if (FALSE) { # \dontrun{
 library(leaflet)
 library(rgee)
 ee_Initialize()
@@ -911,7 +909,7 @@ 
Examples

 
 # character palette
 Map$addLegend(vis_qc, name = "Legend2", color_mapping = "character")
-}
+} # }
@@ -926,15 +924,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee.html b/reference/ee.html index 126241c5..29bdab93 100644 --- a/reference/ee.html +++ b/reference/ee.html @@ -1,11 +1,11 @@ -Main Earth Engine module — ee • rgeeMain Earth Engine module — ee • rgee - +
- +

Main Earth Engine module

- Source: R/ee_module.R + Source: R/ee_module.R
@@ -112,7 +112,7 @@

Format

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_Initialize()
@@ -122,7 +122,7 @@ 
Examples

 
 print(ee_img$getInfo())
 print(ee_ic$getInfo())
-}
+} # }
@@ -137,15 +137,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_Authenticate.html b/reference/ee_Authenticate.html index 90d9cecd..78445f93 100644 --- a/reference/ee_Authenticate.html +++ b/reference/ee_Authenticate.html @@ -1,9 +1,9 @@ -Prompts the user to authorize access to Earth Engine via OAuth2. — ee_Authenticate • rgeePrompts the user to authorize access to Earth Engine via OAuth2. — ee_Authenticate • rgee - +
- +

Prompts the user to authorize access to Earth Engine via OAuth2.

- Source: R/ee_Initialize.R + Source: R/ee_Initialize.R
@@ -114,36 +114,38 @@

Prompts the user to authorize access to Earth Engine via OAuth2.

Arguments

-
user
+ + +
user

Character (optional). If is a character, the credentials are saved in the dirpath: ~/.config/earthengine/$user. If is NULL, the credentials are stored in ~/.config/earthengine.

-
earthengine
+
earthengine

Logical (optional). If TRUE, the EarthEngine credential is cached in the path ~/.config/earthengine/.

-
drive
+
drive

Logical (optional). If TRUE, the drive credential is cached in the path ~/.config/earthengine/.

-
gcs
+
gcs

Logical (optional). If TRUE, the Google Cloud Storage credential is cached in the path ~/.config/earthengine/.

-
authorization_code
+
authorization_code

An optional authorization code.

-
code_verifier
+
code_verifier

PKCE verifier to prevent auth code stealing.

-
auth_mode
+
auth_mode

The authentication mode. One of:

  • 1. paste - send user to accounts.google.com to get a pastable token

  • 2. notebook - send user to notebook authenticator page

  • 3. gcloud - use gcloud to obtain credentials (will set appdefault)

    • @@ -152,24 +154,24 @@

    Arguments

-
scopes
+
scopes

List of scopes to use for authentication. Defaults to 'https://www.googleapis.com/auth/earthengine' or 'https://www.googleapis.com/auth/devstorage.full_control'

-
quiet
-

If TRUE, do not require interactive prompts and force --no-browser mode for gcloud.

+
quiet
+

If TRUE, do not require interactive prompts and force –no-browser mode for gcloud.

-
verbose
+
verbose

Logical. Suppress info messages.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 # Simple init - Load just the Earth Engine credential
@@ -178,7 +180,7 @@ 
Examples

 # At Server side
 ee_Authenticate(quiet=TRUE)
 
-}
+} # }
@@ -193,15 +195,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_Initialize.html b/reference/ee_Initialize.html index e52693dd..dc81ce71 100644 --- a/reference/ee_Initialize.html +++ b/reference/ee_Initialize.html @@ -1,5 +1,5 @@ -Authenticate and Initialize Earth Engine — ee_Initialize • rgeeAuthenticate and Initialize Earth Engine — ee_Initialize • rgee - +
- +

Authenticate and Initialize Earth Engine

- Source: R/ee_Initialize.R + Source: R/ee_Initialize.R
@@ -124,49 +124,51 @@

Authenticate and Initialize Earth Engine

Arguments

-
user
+ + +
user

Character (optional, e.g. data.colec.fbf). The user parameter is used to create a folder inside the path ~/.config/earthengine/ where all the credentials for a specific Google identity are saved.

-
drive
+
drive

Logical (optional). If set to TRUE, the drive credential will be cached in the path ~/.config/earthengine/.

-
gcs
+
gcs

Logical (optional). If TRUE, the Google Cloud Storage credential will be cached in the path ~/.config/earthengine/.

-
credentials
+
credentials

OAuth2 GEE credentials. 'persistent' (default) means it will use the GEE credentials already stored in the filesystem. If the credentials are not found, it will raise an explanatory exception guiding the user to create those credentials.

-
opt_url
+
opt_url

The base url for the EarthEngine REST API to connect to.

-
cloud_api_key
+
cloud_api_key

An optional API key to use the Cloud API.

-
http_transport
+
http_transport

The HTTP transport method to use for making requests

-
project
+
project

The client project ID or number to be used for making API calls.

-
quiet
+
quiet

Logical. Suppress info messages.

-
auth_mode
+
auth_mode

The authentication mode. One of:

  • 1. paste - send user to accounts.google.com to get a pastable token

  • 2. notebook - send user to notebook authenticator page

  • 3. gcloud - use gcloud to obtain credentials (will set appdefault)

    • @@ -175,20 +177,18 @@

    Arguments

-
auth_quiet
+
auth_quiet

Logical. ee_Authenticate quiet parameter. If TRUE, -do not require interactive prompts and force --no-browser mode for gcloud.

+do not require interactive prompts and force –no-browser mode for gcloud.

-
...
+
...

Extra exporting argument. See ee_Authenticate.

Value

- - -

No return value, called for initializing the earthengine-api.

+

No return value, called for initializing the earthengine-api.

Details

@@ -201,7 +201,7 @@

Details

See also

-

Other session management functions: +

Other session management functions: ee_user_info(), ee_users(), ee_version()

@@ -209,13 +209,13 @@

See also

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 # Simple init - Load just the Earth Engine credential
 ee_Initialize()
 ee_user_info()
-}
+} # }
@@ -230,15 +230,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_as_rast.html b/reference/ee_as_rast.html index bda2306f..4735499c 100644 --- a/reference/ee_as_rast.html +++ b/reference/ee_as_rast.html @@ -1,9 +1,9 @@ -Convert an Earth Engine (EE) image in a SpatRaster object — ee_as_rast • rgeeConvert an Earth Engine (EE) image in a SpatRaster object — ee_as_rast • rgee - +
- +

Convert an Earth Engine (EE) image in a SpatRaster object

- Source: R/ee_image.R + Source: R/ee_image.R
@@ -118,83 +118,83 @@

Convert an Earth Engine (EE) image in a SpatRaster object

Arguments

-
image
+ + +
image

ee$Image to be converted into a SpatRaster object.

-
region
+
region

EE Geometry (ee$Geometry$Polygon) which specifies the region to export. CRS needs to be the same that the argument image. Otherwise, it will be forced. If not specified, image bounds are taken.

-
dsn
+
dsn

Character. Output filename. If missing, a temporary file is created.

-
via
+
via

Character. Method to export the image. Three methods are implemented: "getDownloadURL", "drive", "gcs". For "drive" and "gcs" see details. Use "getDownloadURL" for small images.

-
container
+
container

Character. Name of the folder ('drive') or bucket ('gcs') to be exported.

-
scale
+
scale

Numeric. The resolution in meters per pixel. Defaults to the native resolution of the image.

-
maxPixels
+
maxPixels

Numeric. The maximum allowable number of pixels in the exported image. If the exported region covers more pixels than the specified limit in the given projection, the task will fail. Defaults to 100,000,000.

-
grid_batch
+
grid_batch

Numeric. Argument used if via is set as "getDownloadURL". The number of pixels to download in each batch without considering the number of bands. Default to 1048576 -(1024*1024).

-
lazy
+
lazy

Logical. If TRUE, a future::sequential object is created to evaluate the task in the future. See details.

-
public
+
public

Logical. If TRUE, a public link to the image is created.

-
add_metadata
+
add_metadata

Add metadata to the stars_proxy object. See details.

-
timePrefix
+
timePrefix

Logical. Add current date and time (Sys.time()) as a prefix to files to export. This parameter helps to avoid exported files with the same name. By default TRUE.

-
quiet
+
quiet

Logical. Suppress info message

-
...
+
...

Extra exporting argument. See ee_image_to_drive and ee_image_to_gcs.

Value

- - -

A SpatRaster object

+

A SpatRaster object

Details

@@ -232,7 +232,7 @@

Details

See also

-

Other image download functions: +

Other image download functions: ee_as_raster(), ee_as_stars(), ee_as_thumbnail(), @@ -241,7 +241,7 @@

See also

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_Initialize(drive = TRUE, gcs = TRUE)
@@ -313,7 +313,7 @@ 
Examples

 # OPTIONAL: clean containers
 # ee_clean_container(name = "rgee_backup", type = "drive")
 # ee_clean_container(name = "rgee_dev", type = "gcs")
-}
+} # }
@@ -328,15 +328,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_as_raster.html b/reference/ee_as_raster.html index d651ba72..1562beab 100644 --- a/reference/ee_as_raster.html +++ b/reference/ee_as_raster.html @@ -1,9 +1,9 @@ -Convert an Earth Engine (EE) image in a raster object — ee_as_raster • rgeeConvert an Earth Engine (EE) image in a raster object — ee_as_raster • rgee - +
- +

Convert an Earth Engine (EE) image in a raster object

- Source: R/Deprecated.R + Source: R/Deprecated.R
@@ -117,76 +117,76 @@

Convert an Earth Engine (EE) image in a raster object

Arguments

-
image
+ + +
image

ee$Image to be converted into a raster object.

-
region
+
region

EE Geometry (ee$Geometry$Polygon) which specifies the region to export. CRS needs to be the same that the argument image. Otherwise, it will be forced. If not specified, image bounds are taken.

-
dsn
+
dsn

Character. Output filename. If missing, a temporary file is created.

-
via
+
via

Character. Method to export the image. Two methods are implemented: "drive", "gcs". See details.

-
container
+
container

Character. Name of the folder ('drive') or bucket ('gcs') to be exported.

-
scale
+
scale

Numeric. The resolution in meters per pixel. Defaults to the native resolution of the image.

-
maxPixels
+
maxPixels

Numeric. The maximum allowed number of pixels in the exported image. The task will fail if the exported region covers more pixels in the specified projection. Defaults to 100,000,000.

-
lazy
+
lazy

Logical. If TRUE, a future::sequential object is created to evaluate the task in the future. See details.

-
public
+
public

Logical. If TRUE, a public link to the image is created.

-
add_metadata
+
add_metadata

Add metadata to the stars_proxy object. See details.

-
timePrefix
+
timePrefix

Logical. Add current date and time (Sys.time()) as a prefix to files to export. This parameter helps to avoid exported files with the same name. By default TRUE.

-
quiet
+
quiet

Logical. Suppress info message

-
...
+
...

Extra exporting argument. See ee_image_to_drive and ee_image_to_gcs.

Value

- - -

A RasterStack object

+

A RasterStack object

Details

@@ -226,7 +226,7 @@

Details

See also

-

Other image download functions: +

Other image download functions: ee_as_rast(), ee_as_stars(), ee_as_thumbnail(), @@ -235,7 +235,7 @@

See also

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_Initialize(drive = TRUE, gcs = TRUE)
@@ -300,7 +300,7 @@ 
Examples

 # OPTIONAL: clean containers
 # ee_clean_container(name = "rgee_backup", type = "drive")
 # ee_clean_container(name = "rgee_dev", type = "gcs")
-}
+} # }
@@ -315,15 +315,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_as_sf.html b/reference/ee_as_sf.html index fe63f9d7..137ff336 100644 --- a/reference/ee_as_sf.html +++ b/reference/ee_as_sf.html @@ -1,9 +1,9 @@ -Convert an Earth Engine table into a sf object — ee_as_sf • rgeeConvert an Earth Engine table into a sf object — ee_as_sf • rgee - +
- +

Convert an Earth Engine table into a sf object

- Source: R/ee_as_sf.R + Source: R/ee_as_sf.R
@@ -117,80 +117,80 @@

Convert an Earth Engine table into a sf object

Arguments

-
x
+ + +
x

Earth Engine table (ee$FeatureCollection) to be converted into a sf object.

-
dsn
+
dsn

Character. Output filename. In case dsn is missing, a shapefile is created in the tmp() directory.

-
overwrite
+
overwrite

Logical. Delete data source dsn before attempting to write?.

-
via
+
via

Character. Method to export the image. Three method are implemented: "getInfo", "drive", "gcs". See details.

-
container
+
container

Character. Name of the folder ('drive') or bucket ('gcs') to be exported into (ignored if via is not defined as "drive" or "gcs").

-
crs
+
crs

Integer or Character. Coordinate Reference System (CRS) for the EE table. If it is NULL, ee_as_sf will take the CRS of the first element.

-
maxFeatures
+
maxFeatures

Numeric. The maximum number of features allowed for export (ignore if via is not set as "getInfo"). The task will fail if the exported region covers more features than the specified in maxFeatures. Default is 5000.

-
selectors
+
selectors

List of properties to include in the output, as a list/vector of strings or a comma-separated string. By default, all properties are included.

-
lazy
+
lazy

Logical. If TRUE, a future::sequential object is created to evaluate the task in the future. Ignore if via is set as "getInfo". See details.

-
public
+
public

Logical. If TRUE, a public link to the file is created. See details.

-
add_metadata
+
add_metadata

Add metadata to the sf object. See details.

-
timePrefix
+
timePrefix

Logical. Add current date and time (Sys.time()) as a prefix to export files. This parameter helps to prevent exported files from having the same name. By default TRUE.

-
quiet
+
quiet

Logical. Suppress info message.

Value

- - -

An sf object.

+

An sf object.

Details

@@ -237,7 +237,7 @@

Details

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_Initialize(drive = TRUE, gcs = TRUE)
@@ -277,7 +277,7 @@ 
Examples

  via = 'gcs',
  container = 'rgee_dev' #GCS bucket name
 )
-}
+} # }
@@ -292,15 +292,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_as_stars.html b/reference/ee_as_stars.html index 5c4b2bf4..10164038 100644 --- a/reference/ee_as_stars.html +++ b/reference/ee_as_stars.html @@ -1,9 +1,9 @@ -Convert an Earth Engine (EE) image in a stars object — ee_as_stars • rgeeConvert an Earth Engine (EE) image in a stars object — ee_as_stars • rgee - +
- +

Convert an Earth Engine (EE) image in a stars object

- Source: R/ee_image.R + Source: R/ee_image.R
@@ -118,83 +118,83 @@

Convert an Earth Engine (EE) image in a stars object

Arguments

-
image
+ + +
image

ee$Image to be converted into a 'stars' object.

-
region
+
region

EE Geometry (ee$Geometry$Polygon) that specifies the region to export. CRS needs to be the same that the argument image. Otherwise, it will be forced. If not specified, image bounds are taken.

-
dsn
+
dsn

Character. Output filename. If missing, a temporary file is created.

-
via
+
via

Character. Method to export the image. Three methods are available: "getDownloadURL", "drive", "gcs". For "drive" and "gcs" see details. Use "getDownloadURL" for small images. Default "getDownloadURL".

-
container
+
container

Character. Name of the folder ('drive') or bucket ('gcs') to be exported.

-
scale
+
scale

Numeric. Image resolution given in meters per pixel. Defaults to the native resolution of the image.

-
maxPixels
+
maxPixels

Numeric. The maximum allowable number of pixels in the exported image. If the exported region covers more pixels than the specified limit in the given projection, the task will fail. Defaults to 100,000,000.

-
grid_batch
+
grid_batch

Numeric. Argument used if 'via' is set as "getDownloadURL". The number of pixels to download in each batch without considering the number of bands. Default to 1048576 -(1024*1024).

-
lazy
+
lazy

Logical. If TRUE, a future::sequential object is created to evaluate the task in the future. See details.

-
public
+
public

Logical. If TRUE, a public link to the image is created.

-
add_metadata
+
add_metadata

Add metadata to the stars_proxy object. See details.

-
timePrefix
+
timePrefix

Logical. Add current date and time (Sys.time()) as a prefix to export files. This parameter helps to avoid exported files with the same name. By default TRUE.

-
quiet
+
quiet

Logical. Suppress info message

-
...
+
...

Extra exporting argument. See ee_image_to_drive and ee_image_to_gcs.

Value

- - -

A stars-proxy object

+

A stars-proxy object

Details

@@ -234,7 +234,7 @@

Details

See also

-

Other image download functions: +

Other image download functions: ee_as_raster(), ee_as_rast(), ee_as_thumbnail(), @@ -243,7 +243,7 @@

See also

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_Initialize(drive = TRUE, gcs = TRUE)
@@ -315,7 +315,7 @@ 
Examples

 # OPTIONAL: clean containers
 # ee_clean_container(name = "rgee_backup", type = "drive")
 # ee_clean_container(name = "rgee_dev", type = "gcs")
-}
+} # }
@@ -330,15 +330,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_as_thumbnail.html b/reference/ee_as_thumbnail.html index ba15b36a..98cf3166 100644 --- a/reference/ee_as_thumbnail.html +++ b/reference/ee_as_thumbnail.html @@ -1,11 +1,11 @@ -Create an R spatial gridded object from an EE thumbnail image — ee_as_thumbnail • rgeeCreate an R spatial gridded object from an EE thumbnail image — ee_as_thumbnail • rgee - +
- +

Create an R spatial gridded object from an EE thumbnail image

- Source: R/ee_as_thumbnail.R + Source: R/ee_as_thumbnail.R
@@ -114,39 +114,39 @@

Create an R spatial gridded object from an EE thumbnail image

Arguments

-
image
+ + +
image

EE Image object to be converted into a stars object.

-
region
+
region

EE Geometry Rectangle (ee$Geometry$Rectangle) specifies the region to be exported. The CRS must match the 'x' argument; otherwise, it will be forced.

-
dimensions
+
dimensions

Numeric vector of length 2 that specifies the dimensions of the thumbnail image in pixels. If only one integer is provided, it determines the size of the larger dimension of the image and scales the other dimension proportionally. Defaults to 512 pixels for the larger image aspect dimension.

-
vizparams
+
vizparams

A list containing the visualization parameters.See details.

-
raster
+
raster

Logical. Should the thumbnail image be saved as a RasterStack object?

-
quiet
+
quiet

logical; suppress info messages.

Value

- - -

An stars or Raster object depending on the raster argument.

+

An stars or Raster object depending on the raster argument.

Details

@@ -163,7 +163,7 @@

Details

(single-band only)comma-separated list of hex stringsopacityThe opacity of the layer (from 0 to 1)number

See also

-

Other image download functions: +

Other image download functions: ee_as_raster(), ee_as_rast(), ee_as_stars(), @@ -172,7 +172,7 @@

See also

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(raster)
 library(stars)
 library(rgee)
@@ -251,7 +251,7 @@ 
Examples

 )
 crs(l8_img) <- "+proj=longlat +datum=WGS84 +no_defs"
 plotRGB(l8_img, stretch = "lin")
-}
+} # }
@@ -266,15 +266,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_check-tools.html b/reference/ee_check-tools.html index fd5400e1..985011b3 100644 --- a/reference/ee_check-tools.html +++ b/reference/ee_check-tools.html @@ -1,5 +1,5 @@ -Interface to check Python and non-R dependencies — ee_check-tools • rgeeInterface to check Python and non-R dependencies — ee_check-tools • rgee - +
- +

Interface to check Python and non-R dependencies

- Source: R/ee_check.R + Source: R/ee_check.R
@@ -119,25 +119,25 @@

Interface to check Python and non-R dependencies

Arguments

-
user
+ + +
user

Character.User to check credentials. If this parameter is not defined, then the check for credentials will be skipped.

-
quiet
+
quiet

Logical. Suppress info message

Value

- - -

No return value, called for checking non-R rgee dependencies.

+

No return value, called for checking non-R rgee dependencies.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_check_python()
@@ -152,7 +152,7 @@ 
Examples

 ## 2. Set the PATH ENV
 # sdkpath <- sprintf("%s/google-cloud-sdk/bin/", Sys.getenv("HOME"))
 # Sys.setenv(PATH=sprintf("%s:%s", Sys.getenv("PATH"), sdkpath))
-}
+} # }
@@ -167,15 +167,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_check.html b/reference/ee_check.html new file mode 100644 index 00000000..1ef168ab --- /dev/null +++ b/reference/ee_check.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_check_credentials.html b/reference/ee_check_credentials.html new file mode 100644 index 00000000..1ef168ab --- /dev/null +++ b/reference/ee_check_credentials.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_check_gcloud.html b/reference/ee_check_gcloud.html new file mode 100644 index 00000000..1ef168ab --- /dev/null +++ b/reference/ee_check_gcloud.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_check_python.html b/reference/ee_check_python.html new file mode 100644 index 00000000..1ef168ab --- /dev/null +++ b/reference/ee_check_python.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_check_python_packages.html b/reference/ee_check_python_packages.html new file mode 100644 index 00000000..1ef168ab --- /dev/null +++ b/reference/ee_check_python_packages.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_check_task_status.html b/reference/ee_check_task_status.html new file mode 100644 index 00000000..b5906824 --- /dev/null +++ b/reference/ee_check_task_status.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_clean_container.html b/reference/ee_clean_container.html index e7f343f5..bc622965 100644 --- a/reference/ee_clean_container.html +++ b/reference/ee_clean_container.html @@ -1,11 +1,11 @@ -Delete files from either a Folder (Google Drive) or a Bucket (GCS) — ee_clean_container • rgeeDelete files from either a Folder (Google Drive) or a Bucket (GCS) — ee_clean_container • rgee - +
- +

Delete files from either a Folder (Google Drive) or a Bucket (GCS)

- Source: R/ee_clean.R + Source: R/ee_clean.R
@@ -107,30 +107,30 @@

Delete files from either a Folder (Google Drive) or a Bucket (GCS)

Arguments

-
name
+ + +
name

Character. Name of the folder (Google Drive) or bucket (GCS) to delete all files.

-
type
+
type

Character. Name of the file storage web service. 'drive' and 'gcs' are supported.

-
quiet
+
quiet

logical. Suppress info message

Value

- - -

No return value, called for cleaning Google Drive or Google +

No return value, called for cleaning Google Drive or Google Cloud Storage container.

See also

-

Other ee_clean functions: +

Other ee_clean functions: ee_clean_pyenv(), ee_clean_user_credentials()

@@ -147,15 +147,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_clean_pyenv.html b/reference/ee_clean_pyenv.html index c93b7559..9cd1fd4c 100644 --- a/reference/ee_clean_pyenv.html +++ b/reference/ee_clean_pyenv.html @@ -1,9 +1,9 @@ -Remove rgee system variables from .Renviron — ee_clean_pyenv • rgeeRemove rgee system variables from .Renviron — ee_clean_pyenv • rgee - +
- +

Remove rgee system variables from .Renviron

- Source: R/ee_clean.R + Source: R/ee_clean.R
@@ -103,7 +103,9 @@

Remove rgee system variables from .Renviron

Arguments

-
Renviron
+ + +
Renviron

Character. If it is "global" the environment variables in the .Renviron located in the Sys.getenv("HOME") folder will be deleted. On the other hand, if it is "local" the environment variables in the .Renviron on the @@ -113,14 +115,12 @@

Arguments

Value

- - -

No return value, called for cleaning environmental variables in +

No return value, called for cleaning environmental variables in their system.

See also

-

Other ee_clean functions: +

Other ee_clean functions: ee_clean_container(), ee_clean_user_credentials()

@@ -137,15 +137,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_clean_user_credentials.html b/reference/ee_clean_user_credentials.html index c3531000..3db88ae2 100644 --- a/reference/ee_clean_user_credentials.html +++ b/reference/ee_clean_user_credentials.html @@ -1,9 +1,9 @@ -Clean credentials for a specific user — ee_clean_user_credentials • rgeeClean credentials for a specific user — ee_clean_user_credentials • rgee - +
- +

Clean credentials for a specific user

- Source: R/ee_clean.R + Source: R/ee_clean.R
@@ -108,48 +108,46 @@

Clean credentials for a specific user

Arguments

-
user
+ + +
user

Character (optional, e.g. data.colec.fbf). The user to remove credentials (See ~/.config/earthengine/). A 'user' represents a set of credentials that certificate a specific Google identity.

-
earthengine
+
earthengine

Logical. Earthengine credential.

-
drive
+
drive

Logical. Google Drive credential.

-
gcs
+
gcs

Logical. Google Cloud Storage credential.

Value

- - -

No return value, called for cleaning the path ~/.config/earthengine/

- - +

No return value, called for cleaning the path ~/.config/earthengine/

See also

-

Other ee_clean functions: +

Other ee_clean functions: ee_clean_container(), ee_clean_pyenv()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 # Delete caducated credentials for a specific user
 ee_clean_user_credentials(earthengine=TRUE, drive=TRUE)
 ee_users()
-}
+} # }
@@ -164,15 +162,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_drive_to_local.html b/reference/ee_drive_to_local.html index d42cc5b5..32e4be93 100644 --- a/reference/ee_drive_to_local.html +++ b/reference/ee_drive_to_local.html @@ -1,9 +1,9 @@ -Move results from Google Drive to a local directory — ee_drive_to_local • rgeeMove results from Google Drive to a local directory — ee_drive_to_local • rgee - +
- +

Move results from Google Drive to a local directory

- Source: R/ee_download.R + Source: R/ee_download.R
@@ -111,43 +111,43 @@

Move results from Google Drive to a local directory

Arguments

-
task
+ + +
task

A generated list obtained after completing an Earth Engine task. See details.

-
dsn
+
dsn

Character. Output filename. If missing, a temporary file will be assigned.

-
overwrite
+
overwrite

A boolean argument that indicates whether filename should be overwritten. By default TRUE.

-
consider
+
consider

Interactive. See details.

-
public
+
public

Logical. If TRUE, a public link to the Google Drive resource is created.

-
metadata
+
metadata

Logical. If TRUE, the metadata related to the Google Drive resource will be exported. See details.

-
quiet
+
quiet

Logical. Suppress info message.

Value

- - -

If metadata is FALSE, will return the filename of the Google +

If metadata is FALSE, will return the filename of the Google Drive resource on their system. Otherwise, a list with two elements (dns and metadata) is returned.

@@ -171,13 +171,13 @@

Details

See also

-

Other generic download functions: +

Other generic download functions: ee_gcs_to_local()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(stars)
 library(sf)
@@ -237,7 +237,7 @@ 
Examples

 
 # Move results from Drive to local
 img <- ee_drive_to_local(task = task_img)
-}
+} # }
@@ -252,15 +252,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_extract.html b/reference/ee_extract.html index 37d62be0..ef98b82a 100644 --- a/reference/ee_extract.html +++ b/reference/ee_extract.html @@ -1,12 +1,12 @@ -Extract values from EE Images or ImageCollections objects — ee_extract • rgeeExtract values from EE Images or ImageCollections objects — ee_extract • rgee - +
- +

Extract values from EE Images or ImageCollections objects

- Source: R/ee_extract.R + Source: R/ee_extract.R
@@ -120,60 +120,60 @@

Extract values from EE Images or ImageCollections objects

Arguments

-
x
+ + +
x

ee$Image.

-
y
+
y

ee$Geometry$*, ee$Feature, ee$FeatureCollection, sfc or sf objects.

-
fun
+
fun

ee$Reducer object. Function to summarize the values. The function must take a single numeric value as an argument and return a single value. See details.

-
scale
+
scale

A nominal scale given in meters of the Image projection to work in. By default 1000.

-
sf
+
sf

Logical. Should the function return an sf object?

-
via
+
via

Character. Method for exporting the image. Three methods are available: "getInfo", "drive", "gcs".

-
container
+
container

Character. Name of the folder ('drive') or bucket ('gcs') to export the image into (ignore if via is not defined as "drive" or "gcs").

-
lazy
+
lazy

Logical. If TRUE, a future::sequential object is created to evaluate the task in the future. Ignore if via is set as "getInfo". See details.

-
quiet
+
quiet

Logical. Suppress info message.

-
...
+
...

ee$Image$reduceRegions additional parameters. See ee_help(ee$Image$reduceRegions) for more details.

Value

- - -

A data.frame or an sf object depending on the sf argument. +

A data.frame or an sf object depending on the sf argument. Column names are extracted from band names. Use ee$Image$rename to rename the bands of an ee$Image. See ee_help(ee$Image$rename).

@@ -229,7 +229,7 @@

Details

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(sf)
 
@@ -292,7 +292,7 @@ 
Examples

  main = "2001 Jan Precipitation - Terraclimate",
  reset = FALSE
 )
-}
+} # }
@@ -307,15 +307,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_gcs_to_local.html b/reference/ee_gcs_to_local.html index 2b62cf26..852cd8fe 100644 --- a/reference/ee_gcs_to_local.html +++ b/reference/ee_gcs_to_local.html @@ -1,10 +1,10 @@ -Move results from Google Cloud Storage to a local directory — ee_gcs_to_local • rgeeMove results from Google Cloud Storage to a local directory — ee_gcs_to_local • rgee - +
- +

Move results from Google Cloud Storage to a local directory

- Source: R/ee_download.R + Source: R/ee_download.R
@@ -112,41 +112,41 @@

Move results from Google Cloud Storage to a local directory

Arguments

-
task
+ + +
task

List generated after the EE task is correctly finished. See details.

-
dsn
+
dsn

Character. Output filename. If missing, a temporary file (i.e. tempfile()) will be assigned.

-
public
+
public

Logical. If TRUE, a public link to Google Cloud Storage resource is created. "Public Access Prevention" may need to be removed. In addition, the bucket access control configuration must be "fine-grained". See GCS public files documentation for more details.

-
metadata
+
metadata

Logical. If TRUE, export the metadata related to the Google Cloud Storage resource. See details.

-
overwrite
+
overwrite

A boolean argument that indicates whether "filename" should be overwritten. By default TRUE.

-
quiet
+
quiet

Logical. Suppress info message

Value

- - -

If metadata is FALSE, will return the filename of the Google +

If metadata is FALSE, will return the filename of the Google Cloud Storage resource on their system. Otherwise, a list with two elements (dns and metadata) is returned.

@@ -166,13 +166,13 @@

Details

See also

-

Other generic download functions: +

Other generic download functions: ee_drive_to_local()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(stars)
 library(sf)
@@ -231,7 +231,7 @@ 
Examples

 
 # Move results from Drive to local
 img <- ee_gcs_to_local(task = task_img)
-}
+} # }
@@ -246,15 +246,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_get_assethome.html b/reference/ee_get_assethome.html index cd3afc05..02d19d92 100644 --- a/reference/ee_get_assethome.html +++ b/reference/ee_get_assethome.html @@ -1,9 +1,9 @@ -Get the Asset home name — ee_get_assethome • rgeeGet the Asset home name — ee_get_assethome • rgee - +
- +

Get the Asset home name

- Source: R/ee_get.R + Source: R/ee_get.R
@@ -103,24 +103,22 @@

Get the Asset home name

Value

- - -

Character. The name of the Earth Engine Asset home +

Character. The name of the Earth Engine Asset home (e.g. users/datacolecfbf)

See also

-

Other path utils: +

Other path utils: ee_get_earthengine_path()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 ee_get_assethome()
-}
+} # }
@@ -135,15 +133,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_get_date_ic.html b/reference/ee_get_date_ic.html index b0f93651..cb9941b3 100644 --- a/reference/ee_get_date_ic.html +++ b/reference/ee_get_date_ic.html @@ -1,9 +1,9 @@ -Get the date of a EE ImageCollection — ee_get_date_ic • rgeeGet the date of a EE ImageCollection — ee_get_date_ic • rgee - +
- +

Get the date of a EE ImageCollection

- Source: R/ee_get.R + Source: R/ee_get.R
@@ -103,20 +103,20 @@

Get the date of a EE ImageCollection

Arguments

-
x
+ + +
x

ee$ImageCollection object

-
time_end
+
time_end

Logical. If TRUE, the system:time_end property is also returned. See details.

Value

- - -

A data.frame with the columns: id (ID of the image), +

A data.frame with the columns: id (ID of the image), time_start, and time_end (only if the argument time_end is set as TRUE). The number of rows depends on the number of images (ee$ImageCollection$size).

@@ -130,7 +130,7 @@

Details

See also

-

Other date functions: +

Other date functions: ee_get_date_img(), eedate_to_rdate(), rdate_to_eedate()

@@ -138,7 +138,7 @@

See also

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(sf)
 ee_Initialize()
@@ -152,7 +152,7 @@ 
Examples

   filterBounds(nc)
 
 ee_get_date_ic(ee_s2)
-}
+} # }
@@ -167,15 +167,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_get_date_img.html b/reference/ee_get_date_img.html index 66711cbe..76ceb798 100644 --- a/reference/ee_get_date_img.html +++ b/reference/ee_get_date_img.html @@ -1,9 +1,9 @@ -Get the date of a EE Image — ee_get_date_img • rgeeGet the date of a EE Image — ee_get_date_img • rgee - +
- +

Get the date of a EE Image

- Source: R/ee_get.R + Source: R/ee_get.R
@@ -103,20 +103,20 @@

Get the date of a EE Image

Arguments

-
x
+ + +
x

ee$Image or ee$ImageCollection object

-
time_end
+
time_end

Logical. If TRUE, the system:time_end property is also returned. See details.

Value

- - -

An List object with the elements: id, time_start and time_end +

An List object with the elements: id, time_start and time_end (only if the time_end argument is TRUE).

@@ -128,7 +128,7 @@

Details

See also

-

Other date functions: +

Other date functions: ee_get_date_ic(), eedate_to_rdate(), rdate_to_eedate()

@@ -136,7 +136,7 @@

See also

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 
@@ -144,7 +144,7 @@ 
Examples

 ee_get_date_img(l8)
 srtm <- ee$Image('CGIAR/SRTM90_V4')
 ee_get_date_img(srtm, time_end = TRUE)
-}
+} # }
@@ -159,15 +159,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_get_earthengine_path.html b/reference/ee_get_earthengine_path.html index 996d2dae..7434f07a 100644 --- a/reference/ee_get_earthengine_path.html +++ b/reference/ee_get_earthengine_path.html @@ -1,9 +1,9 @@ -Get the path where the credentials are stored — ee_get_earthengine_path • rgeeGet the path where the credentials are stored — ee_get_earthengine_path • rgee - +
- +

Get the path where the credentials are stored

- Source: R/ee_get.R + Source: R/ee_get.R
@@ -103,14 +103,12 @@

Get the path where the credentials are stored

Value

- - -

A character that represents the path credential of a specific +

A character that represents the path credential of a specific user

See also

-

Other path utils: +

Other path utils: ee_get_assethome()

@@ -126,15 +124,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_help.html b/reference/ee_help.html index 2fcaa85e..f97720b2 100644 --- a/reference/ee_help.html +++ b/reference/ee_help.html @@ -1,9 +1,9 @@ -Documentation for Earth Engine Objects — ee_help • rgeeDocumentation for Earth Engine Objects — ee_help • rgee - +
- +

Documentation for Earth Engine Objects

- Source: R/ee_help.R + Source: R/ee_help.R
@@ -103,30 +103,30 @@

Documentation for Earth Engine Objects

Arguments

-
eeobject
+ + +
eeobject

Earth Engine Object to print documentation.

-
browser
+
browser

Logical. Display documentation in the browser.

Value

- - -

No return value, called for displaying Earth Engine documentation.

+

No return value, called for displaying Earth Engine documentation.

See also

-

Other helper functions: +

Other helper functions: ee_monitoring(), ee_print()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 
@@ -135,7 +135,7 @@ 
Examples

 ee$Geometry$Rectangle(c(-110.8, 44.6, -110.6, 44.7)) %>% ee_help()
 ee$Image %>% ee_help()
 ee$Image %>% ee_help(browser = TRUE)
-}
+} # }
@@ -150,15 +150,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_image_info.html b/reference/ee_image_info.html index e2318261..fcd2479e 100644 --- a/reference/ee_image_info.html +++ b/reference/ee_image_info.html @@ -1,10 +1,10 @@ -Approximate size of an EE Image object — ee_image_info • rgeeApproximate size of an EE Image object — ee_image_info • rgee - +
- +

Approximate size of an EE Image object

- Source: R/ee_image.R + Source: R/ee_image.R
@@ -111,41 +111,41 @@

Approximate size of an EE Image object

Arguments

-
image
+ + +
image

Single-band EE Image object.

-
band_metadata
+
band_metadata

A list with image properties. If NULL it will be automatically generated.

-
getsize
+
getsize

Logical. If TRUE, the function will estimate the size of the object

-
compression_ratio
+
compression_ratio

Numeric. Measurement of the relative data size reduction produced by a data compression algorithm (ignored if getsize is FALSE). By default is 20.

-
quiet
+
quiet

Logical. Suppress info message

Value

- - -

A list containing information about the number of rows (nrow), +

A list containing information about the number of rows (nrow), number of columns (ncol), total number of pixels (total_pixel), and image size (image_size).

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 
@@ -156,7 +156,7 @@ 
Examples

 # Landast8
 l8 <- ee$Image("LANDSAT/LC08/C01/T1_SR/LC08_038029_20180810")$select("B4")
 ee_image_info(l8)
-}
+} # }
@@ -171,15 +171,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_image_to_asset.html b/reference/ee_image_to_asset.html index 41f93e60..b9ecf664 100644 --- a/reference/ee_image_to_asset.html +++ b/reference/ee_image_to_asset.html @@ -1,10 +1,10 @@ -Creates a task to export an EE Image to their EE Assets. — ee_image_to_asset • rgeeCreates a task to export an EE Image to their EE Assets. — ee_image_to_asset • rgee - +
- +

Creates a task to export an EE Image to their EE Assets.

- Source: R/ee_download.R + Source: R/ee_download.R
@@ -117,52 +117,54 @@

Creates a task to export an EE Image to their EE Assets.

Arguments

-
image
+ + +
image

The image to be exported.

-
description
+
description

Human-readable name of the task.

-
assetId
+
assetId

The destination asset ID.

-
overwrite
+
overwrite

Specifies whether to overwrite the assetId if it already exists.

-
pyramidingPolicy
+
pyramidingPolicy

The pyramiding policy to apply to each band in the image, a dictionary keyed by band name. Values must be one of: "mean", "sample", "min", "max", or "mode". Defaults to "mean". A special key, ".default", may be used to change the default for all bands.

-
dimensions
+
dimensions

Defines the image dimensions for export. It can be specified as a single positive integer for the maximum dimension or in "WIDTHxHEIGHT" format, where WIDTH and HEIGHT are positive integers.

-
region
+
region

The lon,lat coordinates for a LinearRing or Polygon specifying the region to export. It can be specified as nested lists of numbers or a serialized string. Defaults to the image's region.

-
scale
+
scale

Resolution given in meters per pixel. Defaults to the native resolution of the image asset unless a crsTransform is specified.

-
crs
+
crs

The coordinate reference system of the exported image's projection. Defaults to the image's default projection.

-
crsTransform
+
crsTransform

A comma-separated string of 6 numbers describing the affine transform of the coordinate reference system of the exported image's projection, in the order: @@ -170,7 +172,7 @@

Arguments

Defaults to the image's native CRS transform.

-
maxPixels
+
maxPixels

The maximum allowed number of pixels in the exported image. The task will fail if the exported region covers more pixels in the specified projection. Defaults to 100,000,000. **kwargs: Holds @@ -180,20 +182,18 @@

Arguments

Value

- - -

An unstarted task

+

An unstarted task

See also

-

Other image export task creator: +

Other image export task creator: ee_image_to_drive(), ee_image_to_gcs()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(stars)
 library(sf)
@@ -254,7 +254,7 @@ 
Examples

 ee_l5 <- ee$Image(assetid)
 Map$centerObject(ee_l5)
 Map$addLayer(ee_l5)
-}
+} # }
@@ -269,15 +269,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_image_to_drive.html b/reference/ee_image_to_drive.html index 58f9fda1..ee3e1603 100644 --- a/reference/ee_image_to_drive.html +++ b/reference/ee_image_to_drive.html @@ -1,11 +1,11 @@ -Creates a task to export an EE Image to Drive. — ee_image_to_drive • rgeeCreates a task to export an EE Image to Drive. — ee_image_to_drive • rgee - +
- +

Creates a task to export an EE Image to Drive.

- Source: R/ee_download.R + Source: R/ee_download.R
@@ -123,51 +123,53 @@

Creates a task to export an EE Image to Drive.

Arguments

-
image
+ + +
image

Image to be exported.

-
description
+
description

User-friendly name of the task.

-
folder
+
folder

Folder name in the user's Drive account where the export will be stored. Default is "rgee-backup".

-
fileNamePrefix
+
fileNamePrefix

Prefix for the export filename in Google Drive. Defaults to the task name.

-
timePrefix
+
timePrefix

Prefixes the current date and time to the exported files.

-
dimensions
+
dimensions

Defines the image dimensions for export. It can be specified as a single positive integer for the maximum dimension or in "WIDTHxHEIGHT" format, where WIDTH and HEIGHT are positive integers.

-
region
+
region

The lon,lat coordinates for a LinearRing or Polygon specifying the region to export. It can be specified as nested lists of numbers or a serialized string. Defaults to the image's region.

-
scale
+
scale

Image resolution in meters per pixel. Defaults to the native resolution of the image asset unless a crsTransform is specified.

-
crs
+
crs

Coordinate reference system of the exported image's projection. Defaults to the image's default projection.

-
crsTransform
+
crsTransform

A comma-separated string of 6 numbers describing the affine transform of the coordinate reference system of the exported image's projection, in the order: xScale, xShearing, xTranslation, @@ -175,18 +177,18 @@

Arguments

CRS transform.

-
maxPixels
+
maxPixels

Maximum number of pixels allowed in the exported image. The task will fail if the exported region exceeds this limit in the specified projection. Defaults to 100,000,000.

-
shardSize
+
shardSize

Size given in pixels of the shards in which the image will be computed. Defaults to 256.

-
fileDimensions
+
fileDimensions

Defines the pixel dimensions for each image file when the image size exceeds the capacity of a single file.To indicate a square shape, use a single number; for width and height, use a list of two dimensions. @@ -194,17 +196,17 @@

Arguments

The specified file dimensions must be a multiple of the shardSize.

-
skipEmptyTiles
+
skipEmptyTiles

If TRUE, skip writing empty (i.e., fully-masked) image tiles. Defaults to FALSE.

-
fileFormat
+
fileFormat

The string file format to which the image is exported. Currently only 'GeoTIFF' and 'TFRecord' are supported, defaults to 'GeoTIFF'.

-
formatOptions
+
formatOptions

A dictionary of string keys to format-specific options. **kwargs: Holds other keyword arguments that may have been deprecated, such as 'crs_transform', 'driveFolder', and 'driveFileNamePrefix'.

@@ -212,20 +214,18 @@

Arguments

Value

- - -

An unstarted task that exports the image to Drive.

+

An unstarted task that exports the image to Drive.

See also

-

Other image export task creator: +

Other image export task creator: ee_image_to_asset(), ee_image_to_gcs()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(stars)
 library(sf)
@@ -284,7 +284,7 @@ 
Examples

 
 # Move results from Drive to local
 ee_drive_to_local(task = task_img)
-}
+} # }
@@ -299,15 +299,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_image_to_gcs.html b/reference/ee_image_to_gcs.html index e368247d..72a03cd6 100644 --- a/reference/ee_image_to_gcs.html +++ b/reference/ee_image_to_gcs.html @@ -1,11 +1,11 @@ -Creates a task to export an EE Image to Google Cloud Storage. — ee_image_to_gcs • rgeeCreates a task to export an EE Image to Google Cloud Storage. — ee_image_to_gcs • rgee - +
- +

Creates a task to export an EE Image to Google Cloud Storage.

- Source: R/ee_download.R + Source: R/ee_download.R
@@ -124,50 +124,52 @@

Creates a task to export an EE Image to Google Cloud Storage.

Arguments

-
image
+ + +
image

The image to be exported.

-
description
+
description

User-friendly name of the task.

-
bucket
+
bucket

Cloud Storage bucket name for the export.

-
fileNamePrefix
+
fileNamePrefix

Cloud Storage object name prefix for the export. Defaults to the name of the task.

-
timePrefix
+
timePrefix

Prefixes the current date and time to the exported files

-
dimensions
+
dimensions

Defines the image dimensions for export. It can be specified as a single positive integer for the maximum dimension or in "WIDTHxHEIGHT" format, where WIDTH and HEIGHT are positive integers.

-
region
+
region

The lon,lat coordinates for a LinearRing or Polygon specifying the region to export. It can be specified as nested lists of numbers or a serialized string. Defaults to the image's region.

-
scale
+
scale

Image resolution in meters per pixel. Defaults to the native resolution of the image asset unless a crsTransform is specified.

-
crs
+
crs

The coordinate reference system of the exported image's projection. Defaults to the image's default projection.

-
crsTransform
+
crsTransform

A comma-separated string of 6 numbers describing the affine transform of the coordinate reference system of the exported image's projection, in the order: @@ -175,18 +177,18 @@

Arguments

Defaults to the image's native CRS transform.

-
maxPixels
+
maxPixels

Maximum number of pixels allowed in the exported image. The task will fail if the exported region exceeds this limit in the specified projection. Defaults to 100,000,000.

-
shardSize
+
shardSize

Size given in pixels of the shards in which the image will be computed. Defaults to 256.

-
fileDimensions
+
fileDimensions

Defines the pixel dimensions for each image file when the image size exceeds the capacity of a single file.To indicate a square shape, use a single number; for width and height, use a list of two dimensions. @@ -194,18 +196,18 @@

Arguments

The specified file dimensions must be a multiple of the shardSize.

-
skipEmptyTiles
+
skipEmptyTiles

If TRUE, skip writing empty (i.e., fully-masked) image tiles. Defaults to FALSE.

-
fileFormat
+
fileFormat

The string file format to which the image is exported. Currently only 'GeoTIFF' and 'TFRecord' are supported, defaults to 'GeoTIFF'.

-
formatOptions
+
formatOptions

A dictionary of string keys to format-specific options. **kwargs: Holds other keyword arguments that may have been deprecated, such as 'crs_transform'.

@@ -213,20 +215,18 @@

Arguments

Value

- - -

An unstarted Task that exports the image to Google Cloud Storage.

+

An unstarted Task that exports the image to Google Cloud Storage.

See also

-

Other image export task creator: +

Other image export task creator: ee_image_to_asset(), ee_image_to_drive()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(stars)
 library(sf)
@@ -286,7 +286,7 @@ 
Examples

 # Move results from GCS to local
 ee_gcs_to_local(task = task_img)
 
-}
+} # }
@@ -301,15 +301,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_imagecollection_to_local.html b/reference/ee_imagecollection_to_local.html index 40caef4a..706aa470 100644 --- a/reference/ee_imagecollection_to_local.html +++ b/reference/ee_imagecollection_to_local.html @@ -1,9 +1,9 @@ -Save an EE ImageCollection to the local system. — ee_imagecollection_to_local • rgeeSave an EE ImageCollection to the local system. — ee_imagecollection_to_local • rgee - +
- +

Save an EE ImageCollection to the local system.

- Source: R/ee_imagecollection.R + Source: R/ee_imagecollection.R
@@ -117,76 +117,76 @@

Save an EE ImageCollection to the local system.

Arguments

-
ic
+ + +
ic

ee$ImageCollection to be saved to the system.

-
region
+
region

EE Geometry (ee$Geometry$Polygon). The CRS needs to be the same that the ic argument. Otherwise, it will be forced.

-
dsn
+
dsn

Character. Output filename. If missing, a temporary file will be created for each image.

-
via
+
via

Character. Method to export the image. Two methods are available: "drive", "gcs". See details.

-
container
+
container

Character. Name of the folder ('drive') or bucket ('gcs') to be exported into (ignored if via is not defined as "drive" or "gcs").

-
scale
+
scale

Numeric. The resolution in meters per pixel. Defaults to the native resolution of the image.

-
maxPixels
+
maxPixels

Numeric. The maximum allowable number of pixels in the exported image. If the exported region covers more pixels than the specified limit in the given projection, the task will fail. Defaults to 100,000,000.

-
lazy
+
lazy

Logical. If TRUE, a future::sequential object is created to evaluate the task in the future. See details.

-
public
+
public

Logical. If TRUE, a public link to the image is created.

-
add_metadata
+
add_metadata

Add metadata to the stars_proxy object. See details.

-
timePrefix
+
timePrefix

Logical. Add current date and time (Sys.time()) as a prefix to export files. This parameter helps to avoid exporting files with the same name. By default TRUE.

-
quiet
+
quiet

Logical. Suppress info message

-
...
+
...

Extra exporting argument. See ee_image_to_drive and

Value

- - -

If add_metadata is FALSE, ee_imagecollection_to_local will +

If add_metadata is FALSE, ee_imagecollection_to_local will return a character vector containing the filename of the images downloaded. Otherwise, if add_metadata is TRUE, will return a list with extra information related to the exportation (see details).

@@ -229,7 +229,7 @@

Details

See also

-

Other image download functions: +

Other image download functions: ee_as_raster(), ee_as_rast(), ee_as_stars(), @@ -238,7 +238,7 @@

See also

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(raster)
 ee_Initialize(drive = TRUE, gcs = TRUE)
@@ -276,7 +276,7 @@ 
Examples

 # From Google Drive to client-side
 doqq_dsn <- ic_drive_files_2 %>% ee_utils_future_value()
 sapply(doqq_dsn, '[[', 1)
-}
+} # }
@@ -291,15 +291,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_install.html b/reference/ee_install.html index 67a21663..60f8bec2 100644 --- a/reference/ee_install.html +++ b/reference/ee_install.html @@ -1,5 +1,5 @@ -Create an isolated Python virtual environment with all rgee dependencies. — ee_install • rgeeCreate an isolated Python virtual environment with all rgee dependencies. — ee_install • rgee - +
- +

Create an isolated Python virtual environment with all rgee dependencies.

- Source: R/ee_install.R + Source: R/ee_install.R
@@ -135,46 +135,46 @@

Create an isolated Python virtual environment with all rgee dependencies.

Arguments

-
py_env
+ + +
py_env

Character. The name, or full path, of the Python environment to be used by rgee.

-
earthengine_version
+
earthengine_version

Character. The Earth Engine Python API version to install. By default rgee::ee_version().

-
python_version
+
python_version

Only Windows users. The Python version to be used in this conda environment. If set to NULL, the default Python package will be used. For example, you can specify python_version = "3.6" to request the creation of the conda environment with a copy of Python 3.6.

-
confirm
+
confirm

Logical. Confirm before restarting R?.

Value

- - -

No return value, called for installing non-R dependencies.

+

No return value, called for installing non-R dependencies.

See also

-

Other ee_install functions: +

Other ee_install functions: ee_install_set_pyenv(), ee_install_upgrade()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 # ee_install()
-}
+} # }
@@ -189,15 +189,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_install_set_pyenv.html b/reference/ee_install_set_pyenv.html index 25d6de03..67b7c6c1 100644 --- a/reference/ee_install_set_pyenv.html +++ b/reference/ee_install_set_pyenv.html @@ -1,5 +1,5 @@ -Specify a Python environment for rgee — ee_install_set_pyenv • rgeeSpecify a Python environment for rgee — ee_install_set_pyenv • rgee - +
- +

Specify a Python environment for rgee

- Source: R/ee_install.R + Source: R/ee_install.R
@@ -119,16 +119,18 @@

Specify a Python environment for rgee

Arguments

-
py_path
+ + +
py_path

The path to a Python interpreter

-
py_env
+
py_env

The name of the conda or venv environment. If NULL, ee_install_upgrade and py_install functions will not work.

-
Renviron
+
Renviron

Character. If it is "global" the environment variables are set in the .Renviron located in the Sys.getenv("HOME") folder. On the other hand, if it is "local" the environment variables are set in the .Renviron on the @@ -136,19 +138,17 @@

Arguments

(see examples).

-
confirm
+
confirm

Logical. Confirm before restarting R?.

-
quiet
+
quiet

Logical. Suppress info message

Value

- - -

no return value, called for setting EARTHENGINE_PYTHON in .Renviron

+

no return value, called for setting EARTHENGINE_PYTHON in .Renviron

Details

@@ -159,14 +159,14 @@

Details

See also

-

Other ee_install functions: +

Other ee_install functions: ee_install_upgrade(), ee_install()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 ## IMPORTANT: Change 'py_path' argument according to your own Python PATH
@@ -225,7 +225,7 @@ 
Examples

 #   py_env = NULL,
 #   Renviron = "local" # Save ENV variables in a local .Renv file
 # )
-}
+} # }
@@ -240,15 +240,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_install_upgrade.html b/reference/ee_install_upgrade.html index cd2ba2d8..29325b98 100644 --- a/reference/ee_install_upgrade.html +++ b/reference/ee_install_upgrade.html @@ -1,9 +1,9 @@ -Upgrade the Earth Engine Python API — ee_install_upgrade • rgeeUpgrade the Earth Engine Python API — ee_install_upgrade • rgee - +
- +

Upgrade the Earth Engine Python API

- Source: R/ee_install.R + Source: R/ee_install.R
@@ -106,35 +106,35 @@

Upgrade the Earth Engine Python API

Arguments

-
version
+ + +
version

Character. The Earth Engine Python API version to upgrade. By default rgee::ee_version().

-
earthengine_env
+
earthengine_env

Character. The name, or full path, of the environment in which the earthengine-api packages are to be installed.

Value

- - -

no return value, called to upgrade the earthengine-api Python package

+

no return value, called to upgrade the earthengine-api Python package

See also

-

Other ee_install functions: +

Other ee_install functions: ee_install_set_pyenv(), ee_install()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 # ee_install_upgrade()
-}
+} # }
@@ -149,15 +149,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_manage-tools.html b/reference/ee_manage-tools.html index 9973390a..1d2b57d4 100644 --- a/reference/ee_manage-tools.html +++ b/reference/ee_manage-tools.html @@ -1,11 +1,11 @@ -Interface to manage the Earth Engine Asset — ee_manage-tools • rgeeInterface to manage the Earth Engine Asset — ee_manage-tools • rgee - +
- +

Interface to manage the Earth Engine Asset

- Source: R/ee_manage.R + Source: R/ee_manage.R
@@ -136,57 +136,59 @@

Interface to manage the Earth Engine Asset

Arguments

-
path_asset
+ + +
path_asset

Character. Name of the EE asset (Table, Image, Folder or ImageCollection).

-
asset_type
+
asset_type

Character. The asset type to create ('Folder' or 'ImageCollection').

-
quiet
+
quiet

Logical. Suppress info message.

-
strict
+
strict

Character vector. If TRUE, the existence of the asset will be evaluated before performing the task.

-
final_path
+
final_path

Character. Output filename (e.g users/datacolecfbf/ic_moved)

-
add_properties
+
add_properties

List. Set of parameters to established as a property of an EE object. See details.

-
del_properties
+
del_properties

Character. Names of properties to be deleted. See details.

-
owner
+
owner

Character vector. Define owner user in the IAM Policy.

-
editor
+
editor

Character vector. Define editor users in the IAM Policy.

-
viewer
+
viewer

Character vector. Define viewer users in the IAM Policy.

-
all_users_can_read
+
all_users_can_read

Logical. All users can see the asset element.

-
cache
+
cache

Logical. If TRUE, the task report will be saved in the /temp directory and used when the function.

@@ -204,7 +206,7 @@

Author

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_Initialize()
@@ -270,7 +272,7 @@ 
Examples

 
 # 9. Delete EE objects or folders
 ee_manage_delete(addm("rgee/"))
-}
+} # }
@@ -285,15 +287,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_manage_asset_access.html b/reference/ee_manage_asset_access.html new file mode 100644 index 00000000..9f51be76 --- /dev/null +++ b/reference/ee_manage_asset_access.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_manage_asset_size.html b/reference/ee_manage_asset_size.html new file mode 100644 index 00000000..9f51be76 --- /dev/null +++ b/reference/ee_manage_asset_size.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_manage_assetlist.html b/reference/ee_manage_assetlist.html new file mode 100644 index 00000000..9f51be76 --- /dev/null +++ b/reference/ee_manage_assetlist.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_manage_cancel_all_running_task.html b/reference/ee_manage_cancel_all_running_task.html new file mode 100644 index 00000000..9f51be76 --- /dev/null +++ b/reference/ee_manage_cancel_all_running_task.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_manage_copy.html b/reference/ee_manage_copy.html new file mode 100644 index 00000000..9f51be76 --- /dev/null +++ b/reference/ee_manage_copy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_manage_create.html b/reference/ee_manage_create.html new file mode 100644 index 00000000..9f51be76 --- /dev/null +++ b/reference/ee_manage_create.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_manage_delete.html b/reference/ee_manage_delete.html new file mode 100644 index 00000000..9f51be76 --- /dev/null +++ b/reference/ee_manage_delete.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_manage_delete_properties.html b/reference/ee_manage_delete_properties.html new file mode 100644 index 00000000..9f51be76 --- /dev/null +++ b/reference/ee_manage_delete_properties.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_manage_move.html b/reference/ee_manage_move.html new file mode 100644 index 00000000..9f51be76 --- /dev/null +++ b/reference/ee_manage_move.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_manage_quota.html b/reference/ee_manage_quota.html new file mode 100644 index 00000000..9f51be76 --- /dev/null +++ b/reference/ee_manage_quota.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_manage_set_properties.html b/reference/ee_manage_set_properties.html new file mode 100644 index 00000000..9f51be76 --- /dev/null +++ b/reference/ee_manage_set_properties.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_manage_task.html b/reference/ee_manage_task.html new file mode 100644 index 00000000..9f51be76 --- /dev/null +++ b/reference/ee_manage_task.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_monitoring.html b/reference/ee_monitoring.html index b4ccf991..d9696f6d 100644 --- a/reference/ee_monitoring.html +++ b/reference/ee_monitoring.html @@ -1,9 +1,9 @@ -Monitoring Earth Engine task progress — ee_monitoring • rgeeMonitoring Earth Engine task progress — ee_monitoring • rgee - +
- +

Monitoring Earth Engine task progress

- Source: R/utils-download.R + Source: R/utils-download.R
@@ -111,50 +111,50 @@

Monitoring Earth Engine task progress

Arguments

-
task
+ + +
task

List generated after a task is started (i.e., after run ee$batch$Task$start()) or a character that represents the ID of a EE task started.

-
task_time
+
task_time

Numeric. How often (in seconds) should a task be polled?

-
eeTaskList
+
eeTaskList

Logical. If TRUE, all Earth Engine tasks will be listed.

-
quiet
+
quiet

Logical. Suppress info message

-
max_attempts
+
max_attempts

Number of times to monitor the tasks before ending.

Value

- - -

An ee$batch$Task object with a state "COMPLETED" or "FAILED" +

An ee$batch$Task object with a state "COMPLETED" or "FAILED" according to the Earth Engine server's response.

See also

-

Other helper functions: +

Other helper functions: ee_help(), ee_print()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 ee_monitoring(eeTaskList = TRUE)
-}
+} # }
@@ -169,15 +169,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_print.ee.feature.Feature.html b/reference/ee_print.ee.feature.Feature.html new file mode 100644 index 00000000..a4872bdb --- /dev/null +++ b/reference/ee_print.ee.feature.Feature.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_print.ee.featurecollection.FeatureCollection.html b/reference/ee_print.ee.featurecollection.FeatureCollection.html new file mode 100644 index 00000000..a4872bdb --- /dev/null +++ b/reference/ee_print.ee.featurecollection.FeatureCollection.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_print.ee.geometry.Geometry.html b/reference/ee_print.ee.geometry.Geometry.html new file mode 100644 index 00000000..a4872bdb --- /dev/null +++ b/reference/ee_print.ee.geometry.Geometry.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_print.ee.image.Image.html b/reference/ee_print.ee.image.Image.html new file mode 100644 index 00000000..a4872bdb --- /dev/null +++ b/reference/ee_print.ee.image.Image.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_print.ee.imagecollection.ImageCollection.html b/reference/ee_print.ee.imagecollection.ImageCollection.html new file mode 100644 index 00000000..a4872bdb --- /dev/null +++ b/reference/ee_print.ee.imagecollection.ImageCollection.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ee_print.html b/reference/ee_print.html index 5c3f146c..1dc99953 100644 --- a/reference/ee_print.html +++ b/reference/ee_print.html @@ -1,12 +1,12 @@ -Print and return metadata about Spatial Earth Engine Objects — ee_print • rgeePrint and return metadata about Spatial Earth Engine Objects — ee_print • rgee - +
- +

Print and return metadata about Spatial Earth Engine Objects

- Source: R/ee_print.R + Source: R/ee_print.R
@@ -106,16 +106,16 @@

Print and return metadata about Spatial Earth Engine Objects

ee_print(eeobject, ...)
 
-# S3 method for ee.geometry.Geometry
+# S3 method for class 'ee.geometry.Geometry'
 ee_print(eeobject, ..., clean = FALSE, quiet = FALSE)
 
-# S3 method for ee.feature.Feature
+# S3 method for class 'ee.feature.Feature'
 ee_print(eeobject, ..., clean = FALSE, quiet = FALSE)
 
-# S3 method for ee.featurecollection.FeatureCollection
+# S3 method for class 'ee.featurecollection.FeatureCollection'
 ee_print(eeobject, ..., f_index = 0, clean = FALSE, quiet = FALSE)
 
-# S3 method for ee.image.Image
+# S3 method for class 'ee.image.Image'
 ee_print(
   eeobject,
   ...,
@@ -126,7 +126,7 @@ 
Print and return metadata about Spatial Earth Engine Objects

   quiet = FALSE
 )
 
-# S3 method for ee.imagecollection.ImageCollection
+# S3 method for class 'ee.imagecollection.ImageCollection'
 ee_print(
   eeobject,
   ...,
@@ -141,65 +141,65 @@ 
Print and return metadata about Spatial Earth Engine Objects

 
     

     
Arguments

-    
eeobject

+
+
+
eeobject

 
Earth Engine Object. Available for: Geometry, Feature,
 FeatureCollection, Image or ImageCollection.

 
 
-
...

+
...

 
ignored

 
 
-
clean

+
clean

 
Logical. If TRUE, the cache will be cleaned.

 
 
-
quiet

+
quiet

 
Logical. Suppress info message

 
 
-
f_index

+
f_index

 
Numeric. Index of the ee$FeatureCollection to fetch.
 Relevant just for ee$FeatureCollection objects.

 
 
-
img_band

+
img_band

 
Character. Band name of the ee$Image to fetch.
 Relevant just for ee$ImageCollection and ee$Image objects.

 
 
-
time_end

+
time_end

 
Logical. If TRUE, the system:time_end property in ee$Image
 is also returned. See rgee::ee_get_date_img for details.

 
 
-
compression_ratio

+
compression_ratio

 
Numeric. Measurement of the relative data size
 reduction produced by a data compression algorithm (ignored if eeobject
 is not an ee$Image or ee$ImageCollection). By default is 20.

 
 
-
img_index

+
img_index

 
Numeric. Index of the ee$ImageCollection to fetch.
 Relevant just for ee$ImageCollection objects.

 
 

     

     
Value

-    
-
-
A list with the metadata of the Earth Engine object.

+    
A list with the metadata of the Earth Engine object.

     

     

     
See also

-    
Other helper functions: 
+    
Other helper functions:
 ee_help(),
 ee_monitoring()

     

 
     

     
Examples

-    
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 
@@ -230,7 +230,7 @@ 
Examples

   filter(ee$Filter()$eq("WRS_ROW", 34))$
   filterDate("2014-03-01", "2014-08-01")$
   aside(ee_print)
-}
+} # }
 

     

   

@@ -245,15 +245,15 @@ 
Examples

 

 
 

-  
Site built with pkgdown 2.0.9.

+  
Site built with pkgdown 2.1.0.
- - + + diff --git a/reference/ee_table_to_asset.html b/reference/ee_table_to_asset.html index 4dc959b4..bdfd312b 100644 --- a/reference/ee_table_to_asset.html +++ b/reference/ee_table_to_asset.html @@ -1,10 +1,10 @@ -Creates a task to export a FeatureCollection to an EE table asset. — ee_table_to_asset • rgeeCreates a task to export a FeatureCollection to an EE table asset. — ee_table_to_asset • rgee - +
- +

Creates a task to export a FeatureCollection to an EE table asset.

- Source: R/ee_download.R + Source: R/ee_download.R
@@ -110,40 +110,40 @@

Creates a task to export a FeatureCollection to an EE table asset.

Arguments

-
collection
+ + +
collection

The feature collection to be exported.

-
description
+
description

Human-readable name of the task.

-
assetId
+
assetId

The destination asset ID. **kwargs: Holds other keyword arguments that may have been deprecated.

-
overwrite
+
overwrite

Logical. If TRUE, the assetId will be overwritten if it exists.

Value

- - -

An unstarted Task that exports the table to Earth Engine Asset.

+

An unstarted Task that exports the table to Earth Engine Asset.

See also

-

Other vector export task creator: +

Other vector export task creator: ee_table_to_drive(), ee_table_to_gcs()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(stars)
 library(sf)
@@ -182,7 +182,7 @@ 
Examples

 ee_fc <- ee$FeatureCollection(assetid)
 Map$centerObject(ee_fc)
 Map$addLayer(ee_fc)
-}
+} # }
@@ -197,15 +197,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_table_to_drive.html b/reference/ee_table_to_drive.html index 7bbc0d6d..0af3a9f8 100644 --- a/reference/ee_table_to_drive.html +++ b/reference/ee_table_to_drive.html @@ -1,10 +1,10 @@ -Creates a task to export a FeatureCollection to Google Drive. — ee_table_to_drive • rgeeCreates a task to export a FeatureCollection to Google Drive. — ee_table_to_drive • rgee - +
- +

Creates a task to export a FeatureCollection to Google Drive.

- Source: R/ee_download.R + Source: R/ee_download.R
@@ -113,34 +113,36 @@

Creates a task to export a FeatureCollection to Google Drive.

Arguments

-
collection
+ + +
collection

The feature collection to be exported.

-
description
+
description

User-friendly name of the task.

-
folder
+
folder

The name of a unique folder in your Drive account to export into. Defaults to the root of the drive.

-
fileNamePrefix
+
fileNamePrefix

The Google Drive filename for the export. Defaults to the name of the task.

-
timePrefix
+
timePrefix

Add current date and time as a prefix to files to export.

-
fileFormat
+
fileFormat

The output format: "CSV" (default), "GeoJSON", "KML", "KMZ", "SHP", or "TFRecord".

-
selectors
+
selectors

A list of properties to include in the output, as a list of strings or a comma-separated string. By default, all properties are included. **kwargs: Holds other keyword arguments @@ -150,20 +152,18 @@

Arguments

Value

- - -

An unstarted Task that exports the table to Google Drive.

+

An unstarted Task that exports the table to Google Drive.

See also

-

Other vector export task creator: +

Other vector export task creator: ee_table_to_asset(), ee_table_to_gcs()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(stars)
 library(sf)
@@ -199,7 +199,7 @@ 
Examples

 task_vector$start()
 ee_monitoring(task_vector) # optional
 ee_drive_to_local(task = task_vector)
-}
+} # }
@@ -214,15 +214,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_table_to_gcs.html b/reference/ee_table_to_gcs.html index 933e54d4..ea12d0db 100644 --- a/reference/ee_table_to_gcs.html +++ b/reference/ee_table_to_gcs.html @@ -1,11 +1,11 @@ -Creates a task to export a FeatureCollection to Google Cloud Storage. — ee_table_to_gcs • rgeeCreates a task to export a FeatureCollection to Google Cloud Storage. — ee_table_to_gcs • rgee - +
- +

Creates a task to export a FeatureCollection to Google Cloud Storage.

- Source: R/ee_download.R + Source: R/ee_download.R
@@ -115,33 +115,35 @@

Creates a task to export a FeatureCollection to Google Cloud Storage.

Arguments

-
collection
+ + +
collection

The feature collection to be exported.

-
description
+
description

User-friendly name of the task.

-
bucket
+
bucket

The name of a Cloud Storage bucket for the export.

-
fileNamePrefix
+
fileNamePrefix

Cloud Storage object name prefix for the export. Defaults to the name of the task.

-
timePrefix
+
timePrefix

Prefixes the current date and time to the exported files.

-
fileFormat
+
fileFormat

The output format: "CSV" (default), "GeoJSON", "KML", "KMZ", "SHP", or "TFRecord".

-
selectors
+
selectors

The list of properties to include in the output, as a list of strings or a comma-separated string. By default, all properties are included. **kwargs: Holds other keyword arguments @@ -150,20 +152,18 @@

Arguments

Value

- - -

An unstarted Task that exports the table to Google Cloud Storage.

+

An unstarted Task that exports the table to Google Cloud Storage.

See also

-

Other vector export task creator: +

Other vector export task creator: ee_table_to_asset(), ee_table_to_drive()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(stars)
 library(sf)
@@ -200,7 +200,7 @@ 
Examples

 ee_monitoring(task_vector) # optional
 amk_geom <- ee_gcs_to_local(task = task_vector)
 plot(sf::read_sf(amk_geom[3]), border = "red", lwd = 10)
-}
+} # }
@@ -215,15 +215,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_user_info.html b/reference/ee_user_info.html index d348abb7..0fab5d35 100644 --- a/reference/ee_user_info.html +++ b/reference/ee_user_info.html @@ -1,9 +1,9 @@ -Display the credentials and general info of the initialized user — ee_user_info • rgeeDisplay the credentials and general info of the initialized user — ee_user_info • rgee - +
- +

Display the credentials and general info of the initialized user

- Source: R/ee_Initialize.R + Source: R/ee_Initialize.R
@@ -103,19 +103,19 @@

Display the credentials and general info of the initialized user

Arguments

-
quiet
+ + +
quiet

Logical. Suppress info messages.

Value

- - -

A list with information about the Earth Engine user.

+

A list with information about the Earth Engine user.

See also

-

Other session management functions: +

Other session management functions: ee_Initialize(), ee_users(), ee_version()

@@ -123,11 +123,11 @@

See also

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 ee_user_info()
-}
+} # }
@@ -142,15 +142,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_users.html b/reference/ee_users.html index da1a042e..4c495fee 100644 --- a/reference/ee_users.html +++ b/reference/ee_users.html @@ -1,10 +1,10 @@ -Display the credentials of all users as a table — ee_users • rgeeDisplay the credentials of all users as a table — ee_users • rgee - +
- +

Display the credentials of all users as a table

- Source: R/ee_Initialize.R + Source: R/ee_Initialize.R
@@ -105,19 +105,19 @@

Display the credentials of all users as a table

Arguments

-
quiet
+ + +
quiet

Logical. Suppress info messages.

Value

- - -

A data.frame with credential information of all users.

+

A data.frame with credential information of all users.

See also

-

Other session management functions: +

Other session management functions: ee_Initialize(), ee_user_info(), ee_version()

@@ -125,10 +125,10 @@

See also

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_users()
-}
+} # }
@@ -143,15 +143,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_utils_cog_metadata.html b/reference/ee_utils_cog_metadata.html index c616bbdc..e38cd72a 100644 --- a/reference/ee_utils_cog_metadata.html +++ b/reference/ee_utils_cog_metadata.html @@ -1,9 +1,9 @@ -Return metadata of a COG tile server — ee_utils_cog_metadata • rgeeReturn metadata of a COG tile server — ee_utils_cog_metadata • rgee - +
- +

Return metadata of a COG tile server

- Source: R/ee_utils.R + Source: R/ee_utils.R
@@ -107,28 +107,28 @@

Return metadata of a COG tile server

Arguments

-
resource
+ + +
resource

Character that represents a COG tile server file.

-
visParams
+
visParams

Visualization parameters see "https://api.cogeo.xyz/docs".

-
titiler_server
+
titiler_server

TiTiler endpoint. Defaults to "https://api.cogeo.xyz/".

Value

- - -

A metadata list for a COG file.

+

A metadata list for a COG file.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
  library(rgee)
 
 server <- "https://s3-us-west-2.amazonaws.com/planet-disaster-data/hurricane-harvey/"
@@ -136,7 +136,7 @@ 
Examples

 resource <- paste0(server, file)
 visParams <- list(nodata = 0, expression = "B3, B2, B1", rescale = "3000, 13500")
 ee_utils_cog_metadata(resource, visParams)
-}
+} # }
@@ -151,15 +151,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_utils_create_json.html b/reference/ee_utils_create_json.html index 9827a472..d8e037ea 100644 --- a/reference/ee_utils_create_json.html +++ b/reference/ee_utils_create_json.html @@ -1,9 +1,9 @@ -Convert an R list into a JSON file in the temp() file — ee_utils_create_json • rgeeConvert an R list into a JSON file in the temp() file — ee_utils_create_json • rgee - +
- +

Convert an R list into a JSON file in the temp() file

- Source: R/utils-upload.R + Source: R/utils-upload.R
@@ -103,23 +103,23 @@

Convert an R list into a JSON file in the temp() file

Arguments

-
x
+ + +
x

List to convert into a JSON file.

Value

- - -

A JSON file saved in a /tmp dir.

+

A JSON file saved in a /tmp dir.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_utils_create_json(list(a=10,b=10))
-}
+} # }
@@ -134,15 +134,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_utils_create_manifest_image.html b/reference/ee_utils_create_manifest_image.html index 6eaffd9c..5e5882a5 100644 --- a/reference/ee_utils_create_manifest_image.html +++ b/reference/ee_utils_create_manifest_image.html @@ -1,12 +1,12 @@ -Create a manifest to upload an image — ee_utils_create_manifest_image • rgee - +
- +

Create a manifest to upload an image

- Source: R/utils-upload.R + Source: R/utils-upload.R
@@ -118,60 +118,60 @@

Create a manifest to upload an image

Arguments

-
gs_uri
+ + +
gs_uri

Character. GCS full path of the image to upload to Earth Engine assets, e.g. gs://rgee_dev/l8.tif

-
assetId
+
assetId

Character. How to call the file once uploaded to the Earth Engine Asset. e.g. users/datacolecfbf/l8.

-
properties
+
properties

List. Set of parameters to be set up as properties of the EE object.

-
start_time
+
start_time

Character. Sets the start time property (system:time_start). It could be a number (timestamp) or a date.

-
end_time
+
end_time

Character. Sets the end time property (system:time_end). It could be a number (timestamp) or a date.

-
pyramiding_policy
+
pyramiding_policy

Character. The pyramid reduction policy to use.

-
returnList
+
returnList

Logical. If TRUE will return the "manifest" as a list. Otherwise, will return a JSON file.

-
quiet
+
quiet

Logical. Suppress info message.

Value

- - -

If returnList is TRUE, a list otherwise a JSON file.

+

If returnList is TRUE, a list otherwise a JSON file.

See also

-

Other generic upload functions: +

Other generic upload functions: ee_utils_create_manifest_table(), local_to_gcs()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 
@@ -189,7 +189,7 @@ 
Examples

   assetId = "users/datacolecfbf/l8",
   returnList = TRUE
 )
-}
+} # }
@@ -204,15 +204,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_utils_create_manifest_table.html b/reference/ee_utils_create_manifest_table.html index a3a8464f..377ee981 100644 --- a/reference/ee_utils_create_manifest_table.html +++ b/reference/ee_utils_create_manifest_table.html @@ -1,12 +1,12 @@ -Create a manifest to upload a table — ee_utils_create_manifest_table • rgee - +
- +

Create a manifest to upload a table

- Source: R/utils-upload.R + Source: R/utils-upload.R
@@ -117,56 +117,56 @@

Create a manifest to upload a table

Arguments

-
gs_uri
+ + +
gs_uri

Character. GCS full path of the table to upload to Earth Engine assets e.g. gs://rgee_dev/nc.zip

-
assetId
+
assetId

Character. How to call the file once uploaded to the Earth Engine Asset. e.g. users/datacolecfbf/nc.

-
start_time
+
start_time

Character. Sets the start time property (system:time_start). It could be a number (timestamp) or a date.

-
end_time
+
end_time

Character. Sets the end time property (system:time_end). It could be a number (timestamp) or a date.

-
properties
+
properties

List. Set of parameters to be set up as properties of the EE object.

-
returnList
+
returnList

Logical. If TRUE will return the "manifest" as a list otherwise will return a JSON file.

-
quiet
+
quiet

Logical. Suppress info message.

Value

- - -

If returnList is TRUE, a list otherwise a JSON file.

+

If returnList is TRUE, a list otherwise a JSON file.

See also

-

Other generic upload functions: +

Other generic upload functions: ee_utils_create_manifest_image(), local_to_gcs()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(sf)
 ee_Initialize(gcs = TRUE)
@@ -187,7 +187,7 @@ 
Examples

   assetId = "users/datacolecfbf/nc",
   returnList = TRUE
 )
-}
+} # }
@@ -202,15 +202,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_utils_dataset_display.html b/reference/ee_utils_dataset_display.html index f2d8394a..30970d0d 100644 --- a/reference/ee_utils_dataset_display.html +++ b/reference/ee_utils_dataset_display.html @@ -1,9 +1,9 @@ -Search into the Earth Engine Data Catalog — ee_utils_dataset_display • rgeeSearch into the Earth Engine Data Catalog — ee_utils_dataset_display • rgee - +
- +

Search into the Earth Engine Data Catalog

- Source: R/ee_utils.R + Source: R/ee_utils.R
@@ -103,25 +103,25 @@

Search into the Earth Engine Data Catalog

Arguments

-
ee_search_dataset
+ + +
ee_search_dataset

Character that represents the EE dataset ID.

Value

- - -

No return value, called for displaying the Earth Engine dataset in the browser.

+

No return value, called for displaying the Earth Engine dataset in the browser.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
  library(rgee)
 
  ee_datasets <- c("WWF/HydroSHEDS/15DIR", "WWF/HydroSHEDS/03DIR")
  ee_utils_dataset_display(ee_datasets)
-}
+} # }
@@ -136,15 +136,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_utils_future_value.html b/reference/ee_utils_future_value.html index ca68d1af..5bc87ed3 100644 --- a/reference/ee_utils_future_value.html +++ b/reference/ee_utils_future_value.html @@ -1,12 +1,12 @@ -The value of a future or the values of all elements in a container — ee_utils_future_value • rgeeThe value of a future or the values of all elements in a container — ee_utils_future_value • rgee - +
- +

The value of a future or the values of all elements in a container

- Source: R/ee_utils.R + Source: R/ee_utils.R
@@ -109,39 +109,35 @@

The value of a future or the values of all elements in a container

Arguments

-
future,
+ + +
future,

x A Future, an environment, a list, or a list environment.

-
stdout
+
stdout

If TRUE, standard output captured while resolving futures is relayed, otherwise not.

-
signal
+
signal

If TRUE, conditions captured while resolving futures are relayed, otherwise not.

-
...
+
...

All arguments used by the S3 methods.

Value

- - -

value() of a Future object returns the value of the future, which can +

value() of a Future object returns the value of the future, which can be any type of R object.

- -

value() of a list, an environment, or a list environment returns an object with the same number of elements and of the same class. Names and dimension attributes are preserved, if available. All future elements are replaced by their corresponding value() values. For all other elements, the existing object is kept as-is.

- -

If signal is TRUE and one of the futures produces an error, then that error is produced.

@@ -162,15 +158,15 @@

Author

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_utils_get_crs.html b/reference/ee_utils_get_crs.html index 240af009..80302588 100644 --- a/reference/ee_utils_get_crs.html +++ b/reference/ee_utils_get_crs.html @@ -1,9 +1,9 @@ -Convert EPSG, ESRI or SR-ORG code into a OGC WKT — ee_utils_get_crs • rgeeConvert EPSG, ESRI or SR-ORG code into a OGC WKT — ee_utils_get_crs • rgee - +
- +

Convert EPSG, ESRI or SR-ORG code into a OGC WKT

- Source: R/utils-upload.R + Source: R/utils-upload.R
@@ -103,26 +103,26 @@

Convert EPSG, ESRI or SR-ORG code into a OGC WKT

Arguments

-
code
+ + +
code

The projection code.

Value

- - -

A character which represents the same projection in WKT2 string.

+

A character which represents the same projection in WKT2 string.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_utils_get_crs("SR-ORG:6864")
 ee_utils_get_crs("EPSG:4326")
 ee_utils_get_crs("ESRI:37002")
-}
+} # }
@@ -137,15 +137,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_utils_py_to_r.html b/reference/ee_utils_py_to_r.html index 1af0a687..b29dec28 100644 --- a/reference/ee_utils_py_to_r.html +++ b/reference/ee_utils_py_to_r.html @@ -1,9 +1,9 @@ -Convert between Python and R objects — ee_utils_py_to_r • rgeeConvert between Python and R objects — ee_utils_py_to_r • rgee - +
- +

Convert between Python and R objects

- Source: R/ee_utils.R + Source: R/ee_utils.R
@@ -103,19 +103,19 @@

Convert between Python and R objects

Arguments

-
x
+ + +
x

A python object

Value

- - -

An R object

+

An R object

See also

-

Other ee_utils functions: +

Other ee_utils functions: ee_utils_pyfunc(), ee_utils_shp_to_zip()

@@ -132,15 +132,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_utils_pyfunc.html b/reference/ee_utils_pyfunc.html index 680b07d7..08ef93b7 100644 --- a/reference/ee_utils_pyfunc.html +++ b/reference/ee_utils_pyfunc.html @@ -1,11 +1,11 @@ -Wrap an R function in a Python function with the same signature. — ee_utils_pyfunc • rgeeWrap an R function in a Python function with the same signature. — ee_utils_pyfunc • rgee - +
- +

Wrap an R function in a Python function with the same signature.

- Source: R/ee_utils.R + Source: R/ee_utils.R
@@ -107,15 +107,15 @@

Wrap an R function in a Python function with the same signature.

Arguments

-
f
+ + +
f

An R function

Value

- - -

A Python function that calls the R function f with the same +

A Python function that calls the R function f with the same signature.

@@ -126,7 +126,7 @@

Note

See also

-

Other ee_utils functions: +

Other ee_utils functions: ee_utils_py_to_r(), ee_utils_shp_to_zip()

@@ -137,7 +137,7 @@

Author

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 
@@ -163,7 +163,7 @@ 
Examples

   )
 )
 ee_newic$mean()$getInfo()$type
-}
+} # }
@@ -178,15 +178,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_utils_sak_copy.html b/reference/ee_utils_sak_copy.html index c697dae8..6acbbdfd 100644 --- a/reference/ee_utils_sak_copy.html +++ b/reference/ee_utils_sak_copy.html @@ -1,9 +1,9 @@ -Stores a Service account key (SaK) inside the EE folder — ee_utils_sak_copy • rgeeStores a Service account key (SaK) inside the EE folder — ee_utils_sak_copy • rgee - +
- +

Stores a Service account key (SaK) inside the EE folder

- Source: R/ee_utils.R + Source: R/ee_utils.R
@@ -103,27 +103,29 @@

Stores a Service account key (SaK) inside the EE folder

Arguments

-
sakfile
+ + +
sakfile

Character. SaK filename. If missing, the SaK of the first user is used.

-
users
+
users

Character. The user related to the SaK file. A SaK file can be related to multiple users.

-
delete
+
delete

Logical. If TRUE, the SaK filename is deleted after copy.

-
quiet
+
quiet

Logical. Suppress info message

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_Initialize()
@@ -134,7 +136,7 @@ 
Examples

 
 # # Copy the sakfile of the user1 to the user2 and user3.
 # ee_utils_sak_copy(users = c("csaybar", "ndef", "ryali93"))
-}
+} # }
@@ -149,15 +151,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_utils_sak_validate.html b/reference/ee_utils_sak_validate.html index 1149bc63..56e109c0 100644 --- a/reference/ee_utils_sak_validate.html +++ b/reference/ee_utils_sak_validate.html @@ -1,11 +1,11 @@ -Validate a Service account key (SaK) — ee_utils_sak_validate • rgee - +
- +

Validate a Service account key (SaK)

- Source: R/ee_utils.R + Source: R/ee_utils.R
@@ -107,23 +107,25 @@

Validate a Service account key (SaK)

Arguments

-
sakfile
+ + +
sakfile

Character. SaK filename.

-
bucket
+
bucket

Character. Name of the GCS bucket. If bucket is not set, rgee will tries to create a bucket using googleCloudStorageR::gcs_create_bucket.

-
quiet
+
quiet

Logical. Suppress info message

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 
 ee_Initialize(gcs = TRUE)
@@ -134,7 +136,7 @@ 
Examples

 
 # Check the SaK for the current user
 ee_utils_sak_validate()
-}
+} # }
@@ -149,15 +151,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_utils_shp_to_zip.html b/reference/ee_utils_shp_to_zip.html index 1cde34e4..e908bc1c 100644 --- a/reference/ee_utils_shp_to_zip.html +++ b/reference/ee_utils_shp_to_zip.html @@ -1,9 +1,9 @@ -Create a zip file from an sf object — ee_utils_shp_to_zip • rgeeCreate a zip file from an sf object — ee_utils_shp_to_zip • rgee - +
- +

Create a zip file from an sf object

- Source: R/ee_utils.R + Source: R/ee_utils.R
@@ -107,35 +107,35 @@

Create a zip file from an sf object

Arguments

-
x
+ + +
x

sf object

-
filename
+
filename

data source name

-
SHP_EXTENSIONS
+
SHP_EXTENSIONS

file extension of the files to save into the zip file. By default: "dbf", "prj", "shp", "shx".

Value

- - -

Character. The full path of the created zip file.

+

Character. The full path of the created zip file.

See also

-

Other ee_utils functions: +

Other ee_utils functions: ee_utils_py_to_r(), ee_utils_pyfunc()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(sf)
 ee_Initialize(gcs = TRUE)
@@ -143,7 +143,7 @@ 
Examples

 # Create sf object
 nc <- st_read(system.file("shape/nc.shp", package="sf"))
 zipfile <- ee_utils_shp_to_zip(nc)
-}
+} # }
@@ -158,15 +158,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/ee_version.html b/reference/ee_version.html index d3f9e32b..1d2fde55 100644 --- a/reference/ee_version.html +++ b/reference/ee_version.html @@ -1,9 +1,9 @@ -Earth Engine API version — ee_version • rgeeEarth Engine API version — ee_version • rgee - +
- +

Earth Engine API version

- Source: R/ee_version.R + Source: R/ee_version.R
@@ -103,13 +103,11 @@

Earth Engine API version

Value

- - -

Character. Earth Engine Python API version used to build rgee.

+

Character. Earth Engine Python API version used to build rgee.

See also

-

Other session management functions: +

Other session management functions: ee_Initialize(), ee_user_info(), ee_users()

@@ -127,15 +125,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/eedate_to_rdate.html b/reference/eedate_to_rdate.html index 7977053f..7a1a41ac 100644 --- a/reference/eedate_to_rdate.html +++ b/reference/eedate_to_rdate.html @@ -1,9 +1,9 @@ -Pass an Earth Engine date object to R — eedate_to_rdate • rgeePass an Earth Engine date object to R — eedate_to_rdate • rgee - +
- +

Pass an Earth Engine date object to R

- Source: R/ee_Date.R + Source: R/ee_Date.R
@@ -103,11 +103,13 @@

Pass an Earth Engine date object to R

Arguments

-
ee_date
+ + +
ee_date

ee$date object (ee$Date)

-
timestamp
+
timestamp

Logical. If TRUE, return the date in milliseconds from the Unix Epoch (1970-01-01 00:00:00 UTC). Otherwise, return the date as a POSIXct object. By default FALSE.

@@ -115,9 +117,7 @@

Arguments

Value

- - -

eedate_to_rdate will return either a numeric timestamp or +

eedate_to_rdate will return either a numeric timestamp or a POSIXct object depending on the timestamp argument.

@@ -132,7 +132,7 @@

Details

See also

-

Other date functions: +

Other date functions: ee_get_date_ic(), ee_get_date_img(), rdate_to_eedate()

@@ -140,14 +140,14 @@

See also

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 
 eeDate <- ee$Date$fromYMD(2010,1,1)
 eedate_to_rdate(eeDate,timestamp = TRUE) # good
 eeDate$getInfo()$value # bad
-}
+} # }
@@ -162,15 +162,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/gcs_to_ee_image.html b/reference/gcs_to_ee_image.html index 6425a8c1..a4f3174e 100644 --- a/reference/gcs_to_ee_image.html +++ b/reference/gcs_to_ee_image.html @@ -1,9 +1,9 @@ -Move a GeoTIFF image from GCS to their EE assets — gcs_to_ee_image • rgeeMove a GeoTIFF image from GCS to their EE assets — gcs_to_ee_image • rgee - +
- +

Move a GeoTIFF image from GCS to their EE assets

- Source: R/utils-upload.R + Source: R/utils-upload.R
@@ -108,35 +108,35 @@

Move a GeoTIFF image from GCS to their EE assets

Arguments

-
manifest
+ + +
manifest

Character. Manifest upload file. See ee_utils_create_manifest_image.

-
overwrite
+
overwrite

Logical. If TRUE, the assetId will be overwritten if it exists.

-
command_line_tool_path
+
command_line_tool_path

Character. Path to the Earth Engine command line tool (CLT). If NULL, rgee assumes that CLT is set in the system PATH. (ignore if via is not defined as "gcs_to_asset").

-
quiet
+
quiet

Logical. Suppress info message.

Value

- - -

Character. The Earth Engine asset ID.

+

Character. The Earth Engine asset ID.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(stars)
 ee_Initialize("csaybar", gcs = TRUE)
@@ -170,7 +170,7 @@ 
Examples

 
 Map$centerObject(ee_stars_01)
 Map$addLayer(ee_stars_01, list(min = 0, max = 255, bands = c("b3", "b2", "b1")))
-}
+} # }
@@ -185,15 +185,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/gcs_to_ee_table.html b/reference/gcs_to_ee_table.html index 718d2480..4048894e 100644 --- a/reference/gcs_to_ee_table.html +++ b/reference/gcs_to_ee_table.html @@ -1,9 +1,9 @@ -Move a zipped shapefile from GCS to their EE Assets — gcs_to_ee_table • rgeeMove a zipped shapefile from GCS to their EE Assets — gcs_to_ee_table • rgee - +
- +

Move a zipped shapefile from GCS to their EE Assets

- Source: R/utils-upload.R + Source: R/utils-upload.R
@@ -108,35 +108,35 @@

Move a zipped shapefile from GCS to their EE Assets

Arguments

-
manifest
+ + +
manifest

Character. manifest upload file. See ee_utils_create_manifest_table.

-
command_line_tool_path
+
command_line_tool_path

Character. Path to the Earth Engine command line tool (CLT). If NULL, rgee assumes that CLT is set in the system PATH. (ignore if via is not defined as "gcs_to_asset").

-
overwrite
+
overwrite

Logical. If TRUE, the assetId will be overwritten if it exists.

-
quiet
+
quiet

Logical. Suppress info message.

Value

- - -

Character. The Earth Engine asset ID.

+

Character. The Earth Engine asset ID.

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(sf)
 ee_Initialize(gcs = TRUE)
@@ -165,7 +165,7 @@ 
Examples

 ee_nc <- gcs_to_ee_table(manifest, overwrite = TRUE)
 ee_monitoring()
 Map$addLayer(ee$FeatureCollection(ee_nc))
-}
+} # }
@@ -180,15 +180,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/index.html b/reference/index.html index 6046a089..c8513b64 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,9 +1,9 @@ -Function reference • rgeePackage index • rgee - +
- +
@@ -424,15 +424,15 @@

Utils

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_to_gcs.html b/reference/local_to_gcs.html index 2e177c77..8dea76e5 100644 --- a/reference/local_to_gcs.html +++ b/reference/local_to_gcs.html @@ -1,9 +1,9 @@ -Upload local files to Google Cloud Storage — local_to_gcs • rgeeUpload local files to Google Cloud Storage — local_to_gcs • rgee - +
- +

Upload local files to Google Cloud Storage

- Source: R/utils-upload.R + Source: R/utils-upload.R
@@ -103,40 +103,40 @@

Upload local files to Google Cloud Storage

Arguments

-
x
+ + +
x

Character. filename.

-
bucket
+
bucket

bucket name you are uploading to

-
predefinedAcl
+
predefinedAcl

Specify user access to object. Passed to googleCloudStorageR::gcs_upload.

-
quiet
+
quiet

Logical. Suppress info message.

Value

- - -

Character that represents the full path of the object in the GCS +

Character that represents the full path of the object in the GCS bucket specified.

See also

-

Other generic upload functions: +

Other generic upload functions: ee_utils_create_manifest_image(), ee_utils_create_manifest_table()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(stars)
 
@@ -147,7 +147,7 @@ 
Examples

 # # Define an image.
 tif <- system.file("tif/L7_ETMs.tif", package = "stars")
 local_to_gcs(x = tif, bucket = 'rgee_dev')
-}
+} # }
@@ -162,15 +162,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/map-operator.html b/reference/map-operator.html index d5d9b12e..1887673d 100644 --- a/reference/map-operator.html +++ b/reference/map-operator.html @@ -1,10 +1,10 @@ -EarthEngineMap + EarthEngineMap; adds data from the second map to the first — map-operator • rgeeEarthEngineMap + EarthEngineMap; adds data from the second map to the first — map-operator • rgee - +
- +

EarthEngineMap + EarthEngineMap; adds data from the second map to the first

- Source: R/Map_operators.R + Source: R/Map_operators.R
@@ -100,20 +100,22 @@

EarthEngineMap + EarthEngineMap; adds data from the second map to the first<

- 
# S3 method for EarthEngineMap
-+(e1, e2)
-
-# S3 method for EarthEngineMap
-|(e1, e2)
+ 
# S3 method for class 'EarthEngineMap'
+e1 + e2
+
+# S3 method for class 'EarthEngineMap'
+e1 | e2

Arguments

-
e1
+ + +
e1

an EarthEngineMap object.

-
e2
+
e2

an EarthEngineMap object.

@@ -134,15 +136,15 @@

Author

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/pipe.html b/reference/pipe.html index 81fd84a7..52b0e15a 100644 --- a/reference/pipe.html +++ b/reference/pipe.html @@ -1,9 +1,9 @@ -Pipe operator — %>% • rgeePipe operator — %>% • rgee - +
- +

Pipe operator

- Source: R/utils-pipe.R + Source: R/utils-pipe.R
@@ -114,15 +114,15 @@

Pipe operator

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/print.ee.computedobject.ComputedObject.html b/reference/print.ee.computedobject.ComputedObject.html index ab7c1119..1f6a95b6 100644 --- a/reference/print.ee.computedobject.ComputedObject.html +++ b/reference/print.ee.computedobject.ComputedObject.html @@ -1,9 +1,9 @@ -print Earth Engine object — print.ee.computedobject.ComputedObject • rgeeprint Earth Engine object — print.ee.computedobject.ComputedObject • rgee - +
- +

print Earth Engine object

- Source: R/print.R + Source: R/print.R
@@ -98,30 +98,30 @@

print Earth Engine object

- 
# S3 method for ee.computedobject.ComputedObject
+    
# S3 method for class 'ee.computedobject.ComputedObject'
 print(x, ..., type = getOption("rgee.print.option"))

Arguments

-
x
+ + +
x

Earth Engine spatial object.

-
...
+
...

ignored

-
type
+
type

Character. What to show about the x object?. Three options are supported: "json", "simply", "ee_print". By default "simply".

Value

- - -

No return value, called for displaying Earth Engine objects.

+

No return value, called for displaying Earth Engine objects.

@@ -136,15 +136,15 @@

Value

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/print.html b/reference/print.html new file mode 100644 index 00000000..d9c95404 --- /dev/null +++ b/reference/print.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/raster_as_ee.html b/reference/raster_as_ee.html index c84229bf..16ae72f7 100644 --- a/reference/raster_as_ee.html +++ b/reference/raster_as_ee.html @@ -1,9 +1,9 @@ -Convert a Raster* object into an EE Image object — raster_as_ee • rgeeConvert a Raster* object into an EE Image object — raster_as_ee • rgee - +
- +

Convert a Raster* object into an EE Image object

- Source: R/raster_as_ee.R + Source: R/raster_as_ee.R
@@ -113,61 +113,61 @@

Convert a Raster* object into an EE Image object

Arguments

-
x
+ + +
x

RasterLayer, RasterStack or RasterBrick object to be converted into an ee$Image.

-
assetId
+
assetId

Character. Destination asset ID for the uploaded file.

-
bucket
+
bucket

Character. Name of the GCS bucket.

-
predefinedAcl
+
predefinedAcl

Specify user access to object. Passed to googleCloudStorageR::gcs_upload.

-
command_line_tool_path
+
command_line_tool_path

Character. Path to the Earth Engine command line tool (CLT). If NULL, rgee assumes that CLT is set in the system PATH. (ignore if via is not defined as "gcs_to_asset").

-
overwrite
+
overwrite

Logical. If TRUE, the assetId will be overwritten.

-
monitoring
+
monitoring

Logical. If TRUE the exportation task will be monitored.

-
quiet
+
quiet

Logical. Suppress info message.

-
...
+
...

parameter(s) passed on to ee_utils_create_manifest_image

Value

- - -

An ee$Image object

+

An ee$Image object

See also

-

Other image upload functions: +

Other image upload functions: stars_as_ee()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(raster)
 library(stars)
 library(rgee)
@@ -209,7 +209,7 @@ 
Examples

 )
 Map$centerObject(ee_stars_02)
 Map$addLayer(ee_stars_02, list(min = 0, max = 255))
-}
+} # }
@@ -224,15 +224,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/rdate_to_eedate.html b/reference/rdate_to_eedate.html index 15705110..1fddad44 100644 --- a/reference/rdate_to_eedate.html +++ b/reference/rdate_to_eedate.html @@ -1,10 +1,10 @@ -Pass an R date object to Earth Engine — rdate_to_eedate • rgee - +
- +

Pass an R date object to Earth Engine

- Source: R/ee_Date.R + Source: R/ee_Date.R
@@ -105,11 +105,13 @@

Pass an R date object to Earth Engine

Arguments

-
date
+ + +
date

R date object

-
timestamp
+
timestamp

Logical. By default, FALSE. If TRUE, return the date in milliseconds from the Unix Epoch (1970-01-01 00:00:00 UTC). Otherwise, return a EE date object.

@@ -117,14 +119,12 @@

Arguments

Value

- - -

rdate_to_eedate will return either a numeric timestamp or +

rdate_to_eedate will return either a numeric timestamp or an ee$Date depending on the timestamp argument.

See also

-

Other date functions: +

Other date functions: ee_get_date_ic(), ee_get_date_img(), eedate_to_rdate()

@@ -132,12 +132,12 @@

See also

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 ee_Initialize()
 rdate_to_eedate('2000-01-01')
 rdate_to_eedate(315532800000) # float number
-}
+} # }
@@ -152,15 +152,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/rgee-package.html b/reference/rgee-package.html index faf30eb4..2c37faa5 100644 --- a/reference/rgee-package.html +++ b/reference/rgee-package.html @@ -1,5 +1,5 @@ -rgee: An R package for interacting with Google Earth Engine — rgee-package • rgeergee: An R package for interacting with Google Earth Engine — rgee-package • rgee - +
- +

rgee: An R package for interacting with Google Earth Engine

- Source: R/rgee-package.R + Source: R/rgee-package.R
@@ -135,111 +135,111 @@

Details

I. Earth Engine Module

- +

Interface to main Earth Engine module. Provides access to top level classes and functions as well as sub-modules (e.g. ee$Image, ee$FeatureCollection$first, etc.).

-
------------------------------------------------------------------------------------------------------------------------------
eeMain Earth Engine module.
------------------------------------------------------------------------------------------------------------------------------
+
——————————————————————————————————————————
eeMain Earth Engine module.
——————————————————————————————————————————

II. Install or set non-R rgee dependencies

- -
------------------------------------------------------------------------------------------------------------------------------
ee_installCreate an isolated Python virtual environment with all rgee dependencies.
ee_install_set_pyenvConfigure which version of Python to use with rgee.
ee_install_upgradeUpgrade the Earth Engine Python API.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
ee_installCreate an isolated Python virtual environment with all rgee dependencies.
ee_install_set_pyenvConfigure which version of Python to use with rgee.
ee_install_upgradeUpgrade the Earth Engine Python API.
——————————————————————————————————————————

III. Check non-R dependencies

- -
------------------------------------------------------------------------------------------------------------------------------
ee_checkCheck all non-R dependencies.
ee_check_pythonCheck Python environment.
ee_check_credentialsCheck Google credentials.
ee_check_python_packagesCheck Python packages: earthengine-api and numpy.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
ee_checkCheck all non-R dependencies.
ee_check_pythonCheck Python environment.
ee_check_credentialsCheck Google credentials.
ee_check_python_packagesCheck Python packages: earthengine-api and numpy.
——————————————————————————————————————————

IV. Clean container, credentials, or rgee system variables

- -
------------------------------------------------------------------------------------------------------------------------------
ee_clean_containerDelete files from either a Folder or a Bucket.
ee_clean_pyenvRemove rgee system variables from .Renviron.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
ee_clean_containerDelete files from either a Folder or a Bucket.
ee_clean_pyenvRemove rgee system variables from .Renviron.
——————————————————————————————————————————

V. Session management

- -
------------------------------------------------------------------------------------------------------------------------------
ee_InitializeAuthenticate and Initialize Earth Engine.
ee_versionEarth Engine API version.
ee_user_infoDisplay the credentials and general info of the initialized user.
ee_usersDisplay the credentials of all users as a table.
ee_get_assethomeGet the Asset home name.
ee_get_earthengine_pathGet the path where the credentials are stored.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
ee_InitializeAuthenticate and Initialize Earth Engine.
ee_versionEarth Engine API version.
ee_user_infoDisplay the credentials and general info of the initialized user.
ee_usersDisplay the credentials of all users as a table.
ee_get_assethomeGet the Asset home name.
ee_get_earthengine_pathGet the path where the credentials are stored.
——————————————————————————————————————————

VII. Transform an R Date to an EE Date or vice versa

- -
------------------------------------------------------------------------------------------------------------------------------
eedate_to_rdatePass an Earth Engine date object to R.
rdate_to_eedatePass an R date object to Earth Engine.
ee_get_date_imgGet the date of a EE Image.
ee_get_date_icGet the date of a EE ImageCollection.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
eedate_to_rdatePass an Earth Engine date object to R.
rdate_to_eedatePass an R date object to Earth Engine.
ee_get_date_imgGet the date of a EE Image.
ee_get_date_icGet the date of a EE ImageCollection.
——————————————————————————————————————————

VIII. Visualization Map

- -
------------------------------------------------------------------------------------------------------------------------------
MapR6 object (Map) to display Earth Engine (EE) spatial objects.
R6MapR6 class to display Earth Engine (EE) spatial objects.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
MapR6 object (Map) to display Earth Engine (EE) spatial objects.
R6MapR6 class to display Earth Engine (EE) spatial objects.
——————————————————————————————————————————

IX. Image download

- -
------------------------------------------------------------------------------------------------------------------------------
ee_as_rasterConvert an Earth Engine (EE) image in a raster object.
ee_as_starsConvert an Earth Engine (EE) image in a stars object.
ee_as_thumbnailCreate an R spatial gridded object from an EE thumbnail image.
ee_image_to_assetCreates a task to export an EE Image to their EE Assets.
ee_image_to_driveCreates a task to export an EE Image to Drive.
ee_image_to_gcsCreates a task to export an EE Image to Google Cloud Storage.
ee_image_infoApproximate size of an EE Image object.
ee_imagecollection_to_localSave an EE ImageCollection in their local system.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
ee_as_rasterConvert an Earth Engine (EE) image in a raster object.
ee_as_starsConvert an Earth Engine (EE) image in a stars object.
ee_as_thumbnailCreate an R spatial gridded object from an EE thumbnail image.
ee_image_to_assetCreates a task to export an EE Image to their EE Assets.
ee_image_to_driveCreates a task to export an EE Image to Drive.
ee_image_to_gcsCreates a task to export an EE Image to Google Cloud Storage.
ee_image_infoApproximate size of an EE Image object.
ee_imagecollection_to_localSave an EE ImageCollection in their local system.
——————————————————————————————————————————

X. Vector download

- -
------------------------------------------------------------------------------------------------------------------------------
ee_as_sfConvert an Earth Engine table in an sf object.
ee_table_to_assetCreates a task to export a FeatureCollection to an EE table asset.
ee_table_to_driveCreates a task to export a FeatureCollection to Google Drive.
ee_table_to_gcsCreates a task to export a FeatureCollection to Google Cloud Storage.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
ee_as_sfConvert an Earth Engine table in an sf object.
ee_table_to_assetCreates a task to export a FeatureCollection to an EE table asset.
ee_table_to_driveCreates a task to export a FeatureCollection to Google Drive.
ee_table_to_gcsCreates a task to export a FeatureCollection to Google Cloud Storage.
——————————————————————————————————————————

XI. Generic download

- -
------------------------------------------------------------------------------------------------------------------------------
ee_drive_to_localMove results from Google Drive to a local directory.
ee_gcs_to_localMove results from Google Cloud Storage to a local directory.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
ee_drive_to_localMove results from Google Drive to a local directory.
ee_gcs_to_localMove results from Google Cloud Storage to a local directory.
——————————————————————————————————————————

XII. Assets management

- -
------------------------------------------------------------------------------------------------------------------------------
ee_manage-toolsInterface to manage the Earth Engine Asset.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
ee_manage-toolsInterface to manage the Earth Engine Asset.
——————————————————————————————————————————

XIII. Upload raster

- -
------------------------------------------------------------------------------------------------------------------------------
stars_as_eeConvert a stars or stars-proxy object into an EE Image object.
raster_as_eeConvert a Raster* object into an EE Image object.
gcs_to_ee_imageMove a GeoTIFF image from GCS to their EE assets.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
stars_as_eeConvert a stars or stars-proxy object into an EE Image object.
raster_as_eeConvert a Raster* object into an EE Image object.
gcs_to_ee_imageMove a GeoTIFF image from GCS to their EE assets.
——————————————————————————————————————————

XIV. Upload vector

- -
------------------------------------------------------------------------------------------------------------------------------
gcs_to_ee_tableMove a zipped shapefile from GCS to their EE Assets.
sf_as_eeConvert an sf object to an EE object.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
gcs_to_ee_tableMove a zipped shapefile from GCS to their EE Assets.
sf_as_eeConvert an sf object to an EE object.
——————————————————————————————————————————

XV. Upload generic

- -
------------------------------------------------------------------------------------------------------------------------------
local_to_gcsUpload local files to Google Cloud Storage.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
local_to_gcsUpload local files to Google Cloud Storage.
——————————————————————————————————————————

XVI. Extract values

- -
------------------------------------------------------------------------------------------------------------------------------
ee_extractExtract values from EE Images or ImageCollections objects.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
ee_extractExtract values from EE Images or ImageCollections objects.
——————————————————————————————————————————

XVII. Helper functions

- -
------------------------------------------------------------------------------------------------------------------------------
ee_helpDocumentation for Earth Engine Objects.
ee_printPrint and return metadata about Spatial Earth Engine Objects.
ee_monitoringMonitoring Earth Engine task progress.
printPrint Earth Engine objects.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
ee_helpDocumentation for Earth Engine Objects.
ee_printPrint and return metadata about Spatial Earth Engine Objects.
ee_monitoringMonitoring Earth Engine task progress.
printPrint Earth Engine objects.
——————————————————————————————————————————

XVIII. Utils functions

- -
------------------------------------------------------------------------------------------------------------------------------
ee_utils_py_to_rConvert between Python and R objects.
ee_utils_pyfuncWrap an R function in a Python function with the same signature.
ee_utils_shp_to_zipCreate a zip file from an sf object.
ee_utils_create_jsonConvert a R list into a JSON file.
ee_utils_create_manifest_imageCreate a manifest to upload an image.
ee_utils_create_manifest_tableCreate a manifest to upload a table.
ee_utils_get_crsConvert EPSG, ESRI or SR-ORG code into a OGC WKT.
ee_utils_future_valueThe value of a future or the values of all elements in a container.
ee_utils_dataset_displaySearch into the Earth Engine Data Catalog.
------------------------------------------------------------------------------------------------------------------------------
+ +
——————————————————————————————————————————
ee_utils_py_to_rConvert between Python and R objects.
ee_utils_pyfuncWrap an R function in a Python function with the same signature.
ee_utils_shp_to_zipCreate a zip file from an sf object.
ee_utils_create_jsonConvert a R list into a JSON file.
ee_utils_create_manifest_imageCreate a manifest to upload an image.
ee_utils_create_manifest_tableCreate a manifest to upload a table.
ee_utils_get_crsConvert EPSG, ESRI or SR-ORG code into a OGC WKT.
ee_utils_future_valueThe value of a future or the values of all elements in a container.
ee_utils_dataset_displaySearch into the Earth Engine Data Catalog.
——————————————————————————————————————————

Acknowledgments

- +

We want to offer a special thanks to Justin Braaten for his wise and @@ -299,15 +299,15 @@

Author

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/rgee.html b/reference/rgee.html new file mode 100644 index 00000000..27a2342b --- /dev/null +++ b/reference/rgee.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/sf_as_ee.html b/reference/sf_as_ee.html index b572585d..6bf0f4d4 100644 --- a/reference/sf_as_ee.html +++ b/reference/sf_as_ee.html @@ -1,9 +1,9 @@ -Convert an sf object to an EE object — sf_as_ee • rgeeConvert an sf object to an EE object — sf_as_ee • rgee - +
- +

Convert an sf object to an EE object

- Source: R/sf_as_ee.R + Source: R/sf_as_ee.R
@@ -117,54 +117,56 @@

Convert an sf object to an EE object

Arguments

-
x
+ + +
x

object of class sf, sfc or sfg.

-
via
+
via

Character. Upload method for sf objects. Three methods are implemented: 'getInfo', 'getInfo_to_asset' and 'gcs_to_asset'. See details.

-
assetId
+
assetId

Character. Destination asset ID for the uploaded file. Ignore if via argument is "getInfo".

-
bucket
+
bucket

Character. Name of the bucket (GCS) to save intermediate files (ignore if via is not defined as "gcs_to_asset").

-
predefinedAcl
+
predefinedAcl

Specify user access to object. Passed to googleCloudStorageR::gcs_upload.

-
command_line_tool_path
+
command_line_tool_path

Character. Path to the Earth Engine command line tool (CLT). If NULL, rgee assumes that CLT is set in the system PATH. (ignore if via is not defined as "gcs_to_asset").

-
overwrite
+
overwrite

A boolean argument that indicates indicating whether "filename" should be overwritten. Ignore if via argument is "getInfo". By default TRUE.

-
monitoring
+
monitoring

Logical. Ignore if via is not set as getInfo_to_asset or gcs_to_asset. If TRUE the exportation task will be monitored.

-
proj
+
proj

Integer or character. Coordinate Reference System (CRS) for the EE object, defaults to "EPSG:4326" (x=longitude, y=latitude).

-
evenOdd
+
evenOdd

Logical. Ignored if x is not a Polygon. If TRUE, polygon interiors will be determined by the even/odd rule, where a point is inside if it crosses an odd number of edges to reach a point at infinity. @@ -173,7 +175,7 @@

Arguments

If unspecified, defaults to TRUE.

-
geodesic
+
geodesic

Logical. Ignored if x is not a Polygon or LineString. Whether line segments should be interpreted as spherical geodesics. If FALSE, indicates that line segments should be interpreted as planar lines @@ -181,23 +183,19 @@

Arguments

(including the default EPSG:4326), or to FALSE if the CRS is projected.

-
quiet
+
quiet

Logical. Suppress info message.

-
...
+
...

ee_utils_create_manifest_table arguments might be included.

Value

- - -

When via is "getInfo" and x is either an sf or sfc object +

When via is "getInfo" and x is either an sf or sfc object with multiple geometries will return an ee$FeatureCollection. For single sfc and sfg objects will return an ee$Geometry$....

- -

If via is either "getInfo_to_asset" or "gcs_to_asset" always will return an ee$FeatureCollection.

@@ -223,7 +221,7 @@

Details

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(sf)
 ee_Initialize()
@@ -274,7 +272,7 @@ 
Examples

   via = 'gcs_to_asset'
 )
 ee_monitoring(max_attempts = Inf)
-}
+} # }
@@ -289,15 +287,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/stars_as_ee.html b/reference/stars_as_ee.html index 1e27ce6f..c70b4545 100644 --- a/reference/stars_as_ee.html +++ b/reference/stars_as_ee.html @@ -1,9 +1,9 @@ -Convert a stars or stars-proxy object into an EE Image object — stars_as_ee • rgeeConvert a stars or stars-proxy object into an EE Image object — stars_as_ee • rgee - +
- +

Convert a stars or stars-proxy object into an EE Image object

- Source: R/raster_as_ee.R + Source: R/raster_as_ee.R
@@ -113,60 +113,60 @@

Convert a stars or stars-proxy object into an EE Image object

Arguments

-
x
+ + +
x

stars or stars-proxy object to be converted into an ee$Image.

-
assetId
+
assetId

Character. Destination asset ID for the uploaded file.

-
bucket
+
bucket

Character. Name of the GCS bucket.

-
predefinedAcl
+
predefinedAcl

Specify user access to object. Passed to googleCloudStorageR::gcs_upload.

-
command_line_tool_path
+
command_line_tool_path

Character. Path to the Earth Engine command line tool (CLT). If NULL, rgee assumes that CLT is set in the system PATH. (ignore if via is not defined as "gcs_to_asset").

-
overwrite
+
overwrite

Logical. If TRUE, the assetId will be overwritten.

-
monitoring
+
monitoring

Logical. If TRUE the exportation task will be monitored.

-
quiet
+
quiet

Logical. Suppress info message.

-
...
+
...

parameter(s) passed on to ee_utils_create_manifest_image

Value

- - -

An ee$Image object

+

An ee$Image object

See also

-

Other image upload functions: +

Other image upload functions: raster_as_ee()

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(rgee)
 library(stars)
 ee_Initialize(gcs = TRUE)
@@ -206,7 +206,7 @@ 
Examples

 )
 Map$centerObject(ee_stars_02)
 Map$addLayer(ee_stars_02, list(min = 0, max = 255))
-}
+} # }
@@ -221,15 +221,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/sitemap.xml b/sitemap.xml index 1327a6d9..d5110347 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1,240 +1,82 @@ - - - - https://r-spatial.github.io/rgee/404.html - - - https://r-spatial.github.io/rgee/CODE_OF_CONDUCT.html - - - https://r-spatial.github.io/rgee/CONTRIBUTING.html - - - https://r-spatial.github.io/rgee/ISSUE_TEMPLATE.html - - - https://r-spatial.github.io/rgee/LICENSE.html - - - https://r-spatial.github.io/rgee/articles/index.html - - - https://r-spatial.github.io/rgee/articles/rgee01.html - - - https://r-spatial.github.io/rgee/articles/rgee02.html - - - https://r-spatial.github.io/rgee/articles/rgee03.html - - - https://r-spatial.github.io/rgee/articles/rgee04.html - - - https://r-spatial.github.io/rgee/articles/rgee05.html - - - https://r-spatial.github.io/rgee/articles/rgee06.html - - - https://r-spatial.github.io/rgee/authors.html - - - https://r-spatial.github.io/rgee/index.html - - - https://r-spatial.github.io/rgee/news/index.html - - - https://r-spatial.github.io/rgee/reference/Map.html - - - https://r-spatial.github.io/rgee/reference/R6Map.html - - - https://r-spatial.github.io/rgee/reference/ee.html - - - https://r-spatial.github.io/rgee/reference/ee_Authenticate.html - - - https://r-spatial.github.io/rgee/reference/ee_Initialize.html - - - https://r-spatial.github.io/rgee/reference/ee_as_rast.html - - - https://r-spatial.github.io/rgee/reference/ee_as_raster.html - - - https://r-spatial.github.io/rgee/reference/ee_as_sf.html - - - https://r-spatial.github.io/rgee/reference/ee_as_stars.html - - - https://r-spatial.github.io/rgee/reference/ee_as_thumbnail.html - - - https://r-spatial.github.io/rgee/reference/ee_check-tools.html - - - https://r-spatial.github.io/rgee/reference/ee_clean_container.html - - - https://r-spatial.github.io/rgee/reference/ee_clean_pyenv.html - - - https://r-spatial.github.io/rgee/reference/ee_clean_user_credentials.html - - - https://r-spatial.github.io/rgee/reference/ee_drive_to_local.html - - - https://r-spatial.github.io/rgee/reference/ee_extract.html - - - https://r-spatial.github.io/rgee/reference/ee_gcs_to_local.html - - - https://r-spatial.github.io/rgee/reference/ee_get_assethome.html - - - https://r-spatial.github.io/rgee/reference/ee_get_date_ic.html - - - https://r-spatial.github.io/rgee/reference/ee_get_date_img.html - - - https://r-spatial.github.io/rgee/reference/ee_get_earthengine_path.html - - - https://r-spatial.github.io/rgee/reference/ee_help.html - - - https://r-spatial.github.io/rgee/reference/ee_image_info.html - - - https://r-spatial.github.io/rgee/reference/ee_image_to_asset.html - - - https://r-spatial.github.io/rgee/reference/ee_image_to_drive.html - - - https://r-spatial.github.io/rgee/reference/ee_image_to_gcs.html - - - https://r-spatial.github.io/rgee/reference/ee_imagecollection_to_local.html - - - https://r-spatial.github.io/rgee/reference/ee_install.html - - - https://r-spatial.github.io/rgee/reference/ee_install_set_pyenv.html - - - https://r-spatial.github.io/rgee/reference/ee_install_upgrade.html - - - https://r-spatial.github.io/rgee/reference/ee_manage-tools.html - - - https://r-spatial.github.io/rgee/reference/ee_monitoring.html - - - https://r-spatial.github.io/rgee/reference/ee_print.html - - - https://r-spatial.github.io/rgee/reference/ee_table_to_asset.html - - - https://r-spatial.github.io/rgee/reference/ee_table_to_drive.html - - - https://r-spatial.github.io/rgee/reference/ee_table_to_gcs.html - - - https://r-spatial.github.io/rgee/reference/ee_user_info.html - - - https://r-spatial.github.io/rgee/reference/ee_users.html - - - https://r-spatial.github.io/rgee/reference/ee_utils_cog_metadata.html - - - https://r-spatial.github.io/rgee/reference/ee_utils_create_json.html - - - https://r-spatial.github.io/rgee/reference/ee_utils_create_manifest_image.html - - - https://r-spatial.github.io/rgee/reference/ee_utils_create_manifest_table.html - - - https://r-spatial.github.io/rgee/reference/ee_utils_dataset_display.html - - - https://r-spatial.github.io/rgee/reference/ee_utils_future_value.html - - - https://r-spatial.github.io/rgee/reference/ee_utils_get_crs.html - - - https://r-spatial.github.io/rgee/reference/ee_utils_py_to_r.html - - - https://r-spatial.github.io/rgee/reference/ee_utils_pyfunc.html - - - https://r-spatial.github.io/rgee/reference/ee_utils_sak_copy.html - - - https://r-spatial.github.io/rgee/reference/ee_utils_sak_validate.html - - - https://r-spatial.github.io/rgee/reference/ee_utils_shp_to_zip.html - - - https://r-spatial.github.io/rgee/reference/ee_version.html - - - https://r-spatial.github.io/rgee/reference/eedate_to_rdate.html - - - https://r-spatial.github.io/rgee/reference/gcs_to_ee_image.html - - - https://r-spatial.github.io/rgee/reference/gcs_to_ee_table.html - - - https://r-spatial.github.io/rgee/reference/index.html - - - https://r-spatial.github.io/rgee/reference/local_to_gcs.html - - - https://r-spatial.github.io/rgee/reference/map-operator.html - - - https://r-spatial.github.io/rgee/reference/pipe.html - - - https://r-spatial.github.io/rgee/reference/print.ee.computedobject.ComputedObject.html - - - https://r-spatial.github.io/rgee/reference/raster_as_ee.html - - - https://r-spatial.github.io/rgee/reference/rdate_to_eedate.html - - - https://r-spatial.github.io/rgee/reference/rgee-package.html - - - https://r-spatial.github.io/rgee/reference/sf_as_ee.html - - - https://r-spatial.github.io/rgee/reference/stars_as_ee.html - + +https://r-spatial.github.io/rgee/404.html +https://r-spatial.github.io/rgee/CODE_OF_CONDUCT.html +https://r-spatial.github.io/rgee/CONTRIBUTING.html +https://r-spatial.github.io/rgee/ISSUE_TEMPLATE.html +https://r-spatial.github.io/rgee/LICENSE.html +https://r-spatial.github.io/rgee/articles/index.html +https://r-spatial.github.io/rgee/articles/rgee01.html +https://r-spatial.github.io/rgee/articles/rgee02.html +https://r-spatial.github.io/rgee/articles/rgee03.html +https://r-spatial.github.io/rgee/articles/rgee04.html +https://r-spatial.github.io/rgee/articles/rgee05.html +https://r-spatial.github.io/rgee/articles/rgee06.html +https://r-spatial.github.io/rgee/authors.html +https://r-spatial.github.io/rgee/index.html +https://r-spatial.github.io/rgee/news/index.html +https://r-spatial.github.io/rgee/reference/Map.html +https://r-spatial.github.io/rgee/reference/R6Map.html +https://r-spatial.github.io/rgee/reference/ee.html +https://r-spatial.github.io/rgee/reference/ee_Authenticate.html +https://r-spatial.github.io/rgee/reference/ee_Initialize.html +https://r-spatial.github.io/rgee/reference/ee_as_rast.html +https://r-spatial.github.io/rgee/reference/ee_as_raster.html +https://r-spatial.github.io/rgee/reference/ee_as_sf.html +https://r-spatial.github.io/rgee/reference/ee_as_stars.html +https://r-spatial.github.io/rgee/reference/ee_as_thumbnail.html +https://r-spatial.github.io/rgee/reference/ee_check-tools.html +https://r-spatial.github.io/rgee/reference/ee_clean_container.html +https://r-spatial.github.io/rgee/reference/ee_clean_pyenv.html +https://r-spatial.github.io/rgee/reference/ee_clean_user_credentials.html +https://r-spatial.github.io/rgee/reference/ee_drive_to_local.html +https://r-spatial.github.io/rgee/reference/ee_extract.html +https://r-spatial.github.io/rgee/reference/ee_gcs_to_local.html +https://r-spatial.github.io/rgee/reference/ee_get_assethome.html +https://r-spatial.github.io/rgee/reference/ee_get_date_ic.html +https://r-spatial.github.io/rgee/reference/ee_get_date_img.html +https://r-spatial.github.io/rgee/reference/ee_get_earthengine_path.html +https://r-spatial.github.io/rgee/reference/ee_help.html +https://r-spatial.github.io/rgee/reference/ee_image_info.html +https://r-spatial.github.io/rgee/reference/ee_image_to_asset.html +https://r-spatial.github.io/rgee/reference/ee_image_to_drive.html +https://r-spatial.github.io/rgee/reference/ee_image_to_gcs.html +https://r-spatial.github.io/rgee/reference/ee_imagecollection_to_local.html +https://r-spatial.github.io/rgee/reference/ee_install.html +https://r-spatial.github.io/rgee/reference/ee_install_set_pyenv.html +https://r-spatial.github.io/rgee/reference/ee_install_upgrade.html +https://r-spatial.github.io/rgee/reference/ee_manage-tools.html +https://r-spatial.github.io/rgee/reference/ee_monitoring.html +https://r-spatial.github.io/rgee/reference/ee_print.html +https://r-spatial.github.io/rgee/reference/ee_table_to_asset.html +https://r-spatial.github.io/rgee/reference/ee_table_to_drive.html +https://r-spatial.github.io/rgee/reference/ee_table_to_gcs.html +https://r-spatial.github.io/rgee/reference/ee_user_info.html +https://r-spatial.github.io/rgee/reference/ee_users.html +https://r-spatial.github.io/rgee/reference/ee_utils_cog_metadata.html +https://r-spatial.github.io/rgee/reference/ee_utils_create_json.html +https://r-spatial.github.io/rgee/reference/ee_utils_create_manifest_image.html +https://r-spatial.github.io/rgee/reference/ee_utils_create_manifest_table.html +https://r-spatial.github.io/rgee/reference/ee_utils_dataset_display.html +https://r-spatial.github.io/rgee/reference/ee_utils_future_value.html +https://r-spatial.github.io/rgee/reference/ee_utils_get_crs.html +https://r-spatial.github.io/rgee/reference/ee_utils_py_to_r.html +https://r-spatial.github.io/rgee/reference/ee_utils_pyfunc.html +https://r-spatial.github.io/rgee/reference/ee_utils_sak_copy.html +https://r-spatial.github.io/rgee/reference/ee_utils_sak_validate.html +https://r-spatial.github.io/rgee/reference/ee_utils_shp_to_zip.html +https://r-spatial.github.io/rgee/reference/ee_version.html +https://r-spatial.github.io/rgee/reference/eedate_to_rdate.html +https://r-spatial.github.io/rgee/reference/gcs_to_ee_image.html +https://r-spatial.github.io/rgee/reference/gcs_to_ee_table.html +https://r-spatial.github.io/rgee/reference/index.html +https://r-spatial.github.io/rgee/reference/local_to_gcs.html +https://r-spatial.github.io/rgee/reference/map-operator.html +https://r-spatial.github.io/rgee/reference/pipe.html +https://r-spatial.github.io/rgee/reference/print.ee.computedobject.ComputedObject.html +https://r-spatial.github.io/rgee/reference/raster_as_ee.html +https://r-spatial.github.io/rgee/reference/rdate_to_eedate.html +https://r-spatial.github.io/rgee/reference/rgee-package.html +https://r-spatial.github.io/rgee/reference/sf_as_ee.html +https://r-spatial.github.io/rgee/reference/stars_as_ee.html +