PielouS: Sequential Pielou's diversity index

In rasterdiv: Diversity Indices for Numerical Matrices

Sequential Pielou's diversity index

Description

Computes Pielou's diversity index using a sequential method, particularly useful for handling large datasets that might not be efficiently processed in a standard, non-sequential manner.

Usage

PielouS(x, window = 1, na.tolerance = 1, debugging = FALSE)

Arguments

x	Input raster data, representing the environmental variable(s) over which the diversity index should be calculated.
window	The size of the half-side of the square moving window used in the calculation. This determines the scale at which diversity is assessed.
na.tolerance	A numeric value (between 0.0 and 1.0) indicating the proportion of NA values that are acceptable in each moving window over the raster data. If the proportion of NA values in a window exceeds this threshold, the resulting value for that window is set as NA. The default is 0.0, indicating no tolerance for NA values.
debugging	Boolean flag indicating whether additional console output should be generated for debugging purposes. Defaults to FALSE.

Value

A matrix or list of matrices, depending on the input, containing the calculated Pielou diversity index values. Each cell in the output matrix represents the diversity index calculated from the corresponding moving window of the input data.

Author(s)

Marcantonio Matteo [e-mail], Martina Iannacito [e-mail], Duccio Rocchini [e-mail]

See Also

Pielou for the standard computation of Pielou's diversity index.

Examples

## Not run: 
# Demonstration of function with hypothetical data
# Ensure you replace this with actual raster data
demo_raster <- #... (your raster data here)
result <- PielouS(x = demo_raster, win = 3, na.tolerance = 0.1, debugging = FALSE)
# proceed with analyzing 'result'

## End(Not run)

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