RenyiS: Sequential Renyi's diversity index

In rasterdiv: Diversity Indices for Numerical Matrices

Sequential Renyi's diversity index

Description

This function calculates the Renyi's diversity index index for each cell in a matrix, considering a specified moving window around each cell.

Usage

RenyiS(
  x,
  window = 1,
  alpha = 1,
  base = exp(1),
  na.tolerance = 1,
  debugging = FALSE
)

Arguments

x	A numeric matrix representing the data on which the index is to be calculated.
window	The width of the moving window to consider for each cell. The actual window size will be '(2 * window + 1) x (2 * window + 1)'. Default is 1.
alpha	(Not used in this function, included for compatibility) The alpha parameter for diversity indices, default is 1.
base	The base of the logarithm used in the Shannon formula, default is 'exp(1)' (natural logarithm).
na.tolerance	The tolerance level for missing data within the moving window. A window will be processed only if the proportion of non-missing data is above this threshold. Value should be between 0 and 1. Default is 1.
debugging	Boolean flag to enable or disable debugging messages. Default is FALSE.

Details

Berger-Parker's diversity index calculated sequentially over a raster matrix.

Value

A matrix of the same dimensions as 'x', where each cell contains the Renyi's diversity index calculated for the window around the cell.

Examples

data <- matrix(runif(100), nrow = 10)
renyi_index <- RenyiS(data, window = 1)

rasterdiv documentation built on Oct. 14, 2024, 5:10 p.m.