ent_tsallis: Tsallis Entropy of a Community

In divent: Entropy Partitioning to Measure Diversity

Tsallis Entropy of a Community

Description

Estimate the entropy of species from abundance or probability data. Several estimators are available to deal with incomplete sampling.

Usage

ent_tsallis(x, q = 1, ...)

## S3 method for class 'numeric'
ent_tsallis(
  x,
  q = 1,
  estimator = c("UnveilJ", "ChaoJost", "ChaoShen", "GenCov", "Grassberger", "Marcon",
    "UnveilC", "UnveiliC", "ZhangGrabchak", "naive", "Bonachela", "Holste"),
  level = NULL,
  probability_estimator = c("Chao2015", "Chao2013", "ChaoShen", "naive"),
  unveiling = c("geometric", "uniform", "none"),
  richness_estimator = c("jackknife", "iChao1", "Chao1", "rarefy", "naive"),
  jack_alpha = 0.05,
  jack_max = 10,
  coverage_estimator = c("ZhangHuang", "Chao", "Turing", "Good"),
  sample_coverage = NULL,
  as_numeric = FALSE,
  ...,
  check_arguments = TRUE
)

## S3 method for class 'species_distribution'
ent_tsallis(
  x,
  q = 1,
  estimator = c("UnveilJ", "ChaoJost", "ChaoShen", "GenCov", "Grassberger", "Marcon",
    "UnveilC", "UnveiliC", "ZhangGrabchak", "naive", "Bonachela", "Holste"),
  level = NULL,
  probability_estimator = c("Chao2015", "Chao2013", "ChaoShen", "naive"),
  unveiling = c("geometric", "uniform", "none"),
  richness_estimator = c("jackknife", "iChao1", "Chao1", "rarefy", "naive"),
  jack_alpha = 0.05,
  jack_max = 10,
  coverage_estimator = c("ZhangHuang", "Chao", "Turing", "Good"),
  gamma = FALSE,
  as_numeric = FALSE,
  ...,
  check_arguments = TRUE
)

Arguments

x	An object, that may be a numeric vector containing abundances or probabilities, or an object of class abundances or probabilities.
q	a number: the order of diversity.
...	Unused.
estimator	An estimator of entropy.
level	the level of interpolation or extrapolation. It may be a sample size (an integer) or a sample coverage (a number between 0 and 1). If not NULL, the asymptotic estimator is ignored.
probability_estimator	a string containing one of the possible estimators of the probability distribution (see probabilities). Used only for extrapolation.
unveiling	a string containing one of the possible unveiling methods to estimate the probabilities of the unobserved species (see probabilities). Used only for extrapolation.
richness_estimator	an estimator of richness to evaluate the total number of species, see div_richness. used for interpolation and extrapolation.
jack_alpha	the risk level, 5% by default, used to optimize the jackknife order.
jack_max	the highest jackknife order allowed. Default is 10.
coverage_estimator	an estimator of sample coverage used by coverage.
sample_coverage	the sample coverage of x calculated elsewhere. Used to calculate the gamma diversity of meta-communities, see details.
as_numeric	if TRUE, a number or a numeric vector is returned rather than a tibble.
check_arguments	if TRUE, the function arguments are verified. Should be set to FALSE to save time when the arguments have been checked elsewhere.
gamma	if TRUE, \gamma diversity, i.e. diversity of the metacommunity, is computed.

Details

Bias correction requires the number of individuals. See div_hill for estimators.

Entropy can be estimated at a specified level of interpolation or extrapolation, either a chosen sample size or sample coverage \insertCiteChao2014divent, rather than its asymptotic value. See accum_tsallis for details.

Value

A tibble with the site names, the estimators used and the estimated entropy.

References

\insertAllCited

Examples

# Entropy of each community
ent_tsallis(paracou_6_abd, q = 2)
# gamma entropy
ent_tsallis(paracou_6_abd, q = 2, gamma = TRUE)

# At 80% coverage
ent_tsallis(paracou_6_abd, level = 0.8)

divent documentation built on Aug. 27, 2025, 9:10 a.m.