Calculates the Hurlbert entropy of order $$k$$ of a probability or abundance vector, and its effective number of species.

Hurlbert(NorP, k = 2, ...)
bcHurlbert(Ns, k = 2, CheckArguments = TRUE)
# S3 method for ProbaVector
Hurlbert(NorP, k = 2, ...,
CheckArguments = TRUE, Ps = NULL)
# S3 method for AbdVector
Hurlbert(NorP, k = 2, ...,
CheckArguments = TRUE, Ns = NULL)
# S3 method for integer
Hurlbert(NorP, k = 2, ...,
CheckArguments = TRUE, Ns = NULL)
# S3 method for numeric
Hurlbert(NorP, k = 2, ...,
CheckArguments = TRUE, Ps = NULL, Ns = NULL)
HurlbertD(NorP, k = 2, ...)
bcHurlbertD(Ns, k = 2, CheckArguments = TRUE)
# S3 method for ProbaVector
HurlbertD(NorP, k = 2, ...,
CheckArguments = TRUE, Ps = NULL)
# S3 method for AbdVector
HurlbertD(NorP, k = 2, ...,
CheckArguments = TRUE, Ns = NULL)
# S3 method for integer
HurlbertD(NorP, k = 2, ...,
CheckArguments = TRUE, Ns = NULL)
# S3 method for numeric
HurlbertD(NorP, k = 2, ...,
CheckArguments = TRUE, Ps = NULL, Ns = NULL)

## Arguments

Ps

A probability vector, summing to 1.

Ns

A numeric vector containing species abundances.

NorP

A numeric vector, an integer vector, an abundance vector (AbdVector) or a probability vector (ProbaVector). Contains either abundances or probabilities.

k

A number: the order of diversity. Default is 2 for Simpson's diversity.

...

CheckArguments

Logical; if TRUE, the function arguments are verified. Should be set to FALSE to save time when the arguments have been checked elsewhere.

## Details

Hurlbert's index of diversity (1971) of order $$k$$ is the expected number of species in a sample of size $$k$$.

Bias correction requires the number of individuals. Use bcHurlbert. It is limited to orders $$k$$ less than or equal to the number of individuals in the community.

The effective number of species HurlbertD (explicit diversity) has been derived by Dauby & Hardy (2012). It is calculated numerically. bcHurlbertD calculates it from the bias-corrected index bcHurlbert.

The functions are designed to be used as simply as possible. Hurlbert is a generic method. If its first argument is an abundance vector, an integer vector or a numeric vector which does not sum to 1, the bias corrected function bcHurlbert is called. Explicit calls to bcHurlbert (with bias correction) or to Hurlbert.ProbaVector (without correction) are possible to avoid ambiguity. The .integer and .numeric methods accept Ps or Ns arguments instead of NorP for backward compatibility.

## Value

A named number equal to the calculated index or diversity. The name is either "Biased" or "Unbiased", depending on the estimator used.

## Examples

# Load Paracou data (number of trees per species in two 1-ha plot of a tropical forest)
data(Paracou618)
# Ns is the total number of trees per species
Ns <- as.AbdVector(Paracou618.MC$Ns) # Species probabilities Ps <- as.ProbaVector(Paracou618.MC$Ns)
# Whittaker plot
plot(Ns) # Calculate Hurlbert entropy of order 2, equal to Simpson's index of diversity
Hurlbert(Ps, 2)
#>   Biased
#> 1.985449
# Calculate an unbiased estimator of Hurlbert entropy of order 2
Hurlbert(Ns, 2)
#> Unbiased
#> 1.986326