shannon_frag: Shannon diversity decomposition

View source: R/shannon_frag.R

shannon_fragR Documentation

Shannon diversity decomposition

Description

Computes Shannon diversity and its decomposition

Usage

shannon_frag(x, gx, f, gf)

Arguments

x

Vector of dimension S (number of species) with the number of individuals observed in each species. NA values are allowed. 0 values are converted to NA.

gx

Vector of dimension S of factors indicating the group of each species. G groups.

f

Vector of dimension G with the number (>0) of fragments in each group

gf

Vector of dimension G of factors indicating the groups to which the fragments "f" belong.

Value

  • shannon: Shannon's total Entropy.

  • within: Within groups entropy.

  • between: Between groups entropy.

  • groups: A data frame with information about each group: relative frequency, internal entropy and number of species.

References

Arnaud Barat, Andreu Sansó, Maite Arilla-Osuna, Ruth Blasco, Iñaki Pérez-Fernández, Gabriel Cifuentes-Alcobenda, Rubén Llorente, Daniel Vivar-Ríos, Ella Assaf, Ran Barkai, Avi Gopher, & Jordi Rosell-Ardèvol (2026) <doi:10.1007/s10816-026-09802-3>.

See Also

shannon

Examples

data(Qesem_s)
data(Qesem_f)
shannon_frag(Qesem_s$HU, Qesem_s$Group, Qesem_f$HU, Qesem_f$Group)


diversityArch documentation built on June 13, 2026, 5:07 p.m.