rarity {microbiome} | R Documentation |
Calculates the community rarity index.
rarity(x, index = "all", rarity.detection = 0.2/100, rarity.prevalence = 20/100)
x |
A species abundance vector, or matrix (taxa/features x samples)
with the absolute count data (no relative abundances), or
|
index |
If the index is given, it will override the other parameters. See the details below for description and references of the standard rarity indices. |
rarity.detection |
Detection threshold for determining rare taxa. |
rarity.prevalence |
Prevalence threshold for determining rare taxa. |
The rarity index characterizes the concentration of species at low abundance.
The following rarity indices are provided:
log_modulo_skewness Quantifies the concentration of the least abundant species by the log-modulo skewness of the arithmetic abundance classes (see Magurran & McGill 2011). These are typically right-skewed; to avoid taking log of occasional negative skews, we follow Locey & Lennon (2016) and use the log-modulo transformation that adds a value of one to each measure of skewness to allow logarithmization. The values q=0.5 and n=50 are used here.
low_abundance Relative proportion of the least abundant species, below the rarity.detection level of 0.2%. The least abundant species are determined separately for each sample regardless of their rarity.prevalence.
noncore_abundance Relative proportion of the non-core species, exceed the rarity.detection level of 0.2% at 50% rarity.prevalence at most. This is complement of the core with the same thresholds.
rare_abundance Relative proportion of the rare taxa in [0,1] - the rare taxa are detected with less than 20% rarity.prevalence, regardless of abundance.
A vector of rarity indices
Contact: Leo Lahti microbiome-admin@googlegroups.com
Kenneth J. Locey and Jay T. Lennon. Scaling laws predict global microbial diversity. PNAS 2016 113 (21) 5970-5975; doi:10.1073/pnas.1521291113.
Magurran AE, McGill BJ, eds (2011) Biological Diversity: Frontiers in Measurement and Assessment (Oxford Univ Press, Oxford), Vol 12
global, log_modulo_skewness, noncore_abundance, low_abundance
data(dietswap) d <- rarity(dietswap, index='low_abundance') # d <- rarity(dietswap, index='all')