Tsallis.wmppp: Tsallis (HCDT) Entropy of a spatialized community

In EricMarcon/SpatDiv: Spatially Explicit Measures of Diversity

Tsallis (HCDT) Entropy of a spatialized community

Description

Calculates the HCDT, also known as Tsallis entropy of order $q$ of a spatialized community.

Usage

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

Arguments

NorP	A wmppp.object, with PointType values as species names.
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.

Details

Tsallis \insertCiteHavrda1967,Daroczy1970,Tsallis1988SpatDiv generalized entropy is a generalized measure of diversity \insertCiteJost2006SpatDiv. See Tsallis for more details.

Value

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

References

\insertAllCited

Examples

Tsallis(Paracou6)

EricMarcon/SpatDiv documentation built on May 25, 2023, 12:54 p.m.