BergerParkerP: Calculate Berger-Parker Index on a Matrix

In mattmar/rasterdiv: Diversity Indices for Numerical Matrices

Calculate Berger-Parker Index on a Matrix

Description

This function computes Berger-Parker Index for each cell of a matrix, using a parallelized approach and considering a specified moving window.

Usage

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

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.
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.
np	The number of processes (cores) which will be spawned. Default value is 2.

Value

A matrix of the same dimensions as 'x', where each cell contains the Berger-Parker Index calculated for the window around the cell.

Examples

## Not run: 
data <- matrix(runif(100), nrow = 10)
bp_index <- BergerParkerP(data, window = 1, np=2)

## End(Not run)

mattmar/rasterdiv documentation built on Feb. 25, 2025, 5:59 p.m.