index_registry: Central Registry of Spectral and Geospatial Indices

View source: R/registry.R

index_registryR Documentation

Central Registry of Spectral and Geospatial Indices

Description

Retrieves metadata for all built-in spectral indices or a specific index by name or category. Metadata includes mathematical formulas, required spectral bands, parameter defaults, purpose, interpretation guidelines, limitations, scale sensitivity, and scientific literature references.

Usage

index_registry(category = NULL)

Arguments

category

Optional character string to filter indices by category (e.g., "vegetation", "water", "urban", "soil", "moisture", "snow").

Value

A data.frame containing the registry of supported indices and their metadata.

Examples

# View all indices
reg <- index_registry()
reg[, c("index", "name", "category")]

# View vegetation indices only
veg_reg <- index_registry(category = "vegetation")
veg_reg$index


GeoIndexR documentation built on Oct. 10, 2026, 5:08 p.m.