gee_install: Install and Configure a Conda Environment for 'rgee'

View source: R/gee_install.R

gee_installR Documentation

Install and Configure a Conda Environment for 'rgee'

Description

Sets up a Conda environment with all required Python and R dependencies for using the rgee package, including a specific version of the earthengine-api. If Conda is not available, the user will be prompted to install Miniconda. The created environment is automatically registered for use with rgee.

Usage

gee_install(conda = "rgee", python_version = "3.10", force_recreate = FALSE)

Arguments

conda

[optional] (character) Name of the Conda environment to create or use. Defaults to "rgee".

python_version

[optional] (character) Python version to use when creating the Conda environment. Defaults to "3.10".

force_recreate

[optional] (logical) If TRUE, deletes and recreates the Conda environment even if it already exists. Defaults to FALSE.

Value

Invisibly returns the name of the Conda environment used or created.

Note

Even after installation, users must manually accept the Conda Terms of Service (ToS) using the 'conda tos accept' command before package installation can proceed. Clear instructions will be provided if ToS acceptance is needed.

Examples

# Example: Creating a Conda environment with 'rgee' dependencies
## Not run: 
  gee_install()

## End(Not run)

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