run_geelite: Build and Update the Grid Statistics Database

View source: R/run_geelite.R

run_geeliteR Documentation

Build and Update the Grid Statistics Database

Description

Collects and stores grid statistics from Google Earth Engine (GEE) data in SQLite format (data/geelite.db), initializes CLI files (cli/...), and initializes or updates the state (state/state.json) and log (log/log.txt) files.

Usage

run_geelite(
  path,
  conda = "rgee",
  user = NULL,
  rebuild = FALSE,
  mode = "local",
  verbose = TRUE
)

Arguments

path

[mandatory] (character) The path to the root directory of the generated database. This must be a writable, non-temporary directory. Avoid using the home directory (~), the current working directory, or the package directory.

conda

[optional] (character) Name of the virtual Conda environment used by the rgee package (default: "rgee").

user

[optional] (character) Specifies the Google account directory within ~/.config/earthengine/. This directory stores credentials for a specific Google account (default: NULL).

rebuild

[optional] (logical) If TRUE, the database and its supplementary files are overwritten based on the configuration file (default: FALSE).

mode

[optional] (character) Mode of data extraction. Currently supports "local" or "drive" (for larger exports via Google Drive). Defaults to "local".

verbose

[optional] (logical) Display computation status and messages (default: TRUE).

Value

Invisibly returns NULL, called for side effects.

Examples

# Example: Build a Grid Statistics Database
## Not run: 
  run_geelite(path = tempdir())

## End(Not run)

geeLite documentation built on Aug. 9, 2025, 1:08 a.m.