Diversity.character: HCDT diversity of a vector of individuals

In EricMarcon/SpatDiv: Spatially Explicit Measures of Diversity

HCDT diversity of a vector of individuals

Description

Diversity calls Tsallis to calculate entropy and transforms it into diversity by calculating its deformed exponential.

Usage

## S3 method for class 'character'
Diversity(NorP, q = 1, Correction = "Best", ..., CheckArguments = TRUE)

Arguments

NorP	A vector of factors.
q	A number: the order of entropy. Some corrections allow only a positive number. Default is 1 for Shannon entropy.
Correction	A string containing one of the possible corrections: "None" (no correction), "ChaoShen", "GenCov", "Grassberger", "Holste", "Bonachela", "ZhangGrabchak", or "ChaoWangJost", "Marcon", "UnveilC", "UnveiliC", "UnveilJ" or "Best", the default value. Currently, "Best" is "ChaoWangJost".
...	Further arguments passed to entropart::Tsallis, entropart::Diversity, entropart::Richness, entropart::Shannon or entropart::Simpson (S3 methods for class 'AbdVector' or 'numeric')
CheckArguments	If TRUE (default), the function arguments are verified. Should be set to FALSE to save time in simulations for example, when the arguments have been checked elsewhere.

Value

A named number equal to the calculated diversity. The name is that of the bias correction used.

Examples

SpeciesList <- as.character(Paracou6$marks$PointType)
Diversity(SpeciesList)

EricMarcon/SpatDiv documentation built on Nov. 28, 2024, 5:23 a.m.