EvennessEigen: Evenness of Eigenvalues for diversity metrics (EE)

Description Usage Arguments Value

View source: R/EE_function.R

Description

Evenness of Eigenvalues for diversity metrics (EE)

Usage

1
2
3
4
5
6
EvennessEigen(
  matrix.M,
  scale = TRUE,
  method = "standardize",
  evenness = "Camargo"
)

Arguments

matrix.M

A matrix containing diversity metrics values (columns) for each sample (lines)

scale

Logical. If TRUE (default) the diversity metrics are scaled to 0 mean and variance of 1 (standardization)

method

Character, the method used to perform the scaling of diversity metrics. Default is "standardize".

evenness

Character, the method used to calculate the Evenness of Eigenvalues. Default is "Camargo". Other options are "Pielou" or "both"

Value

A scalar (if used "Camargo" or "Pielou") or a numeric vector of length 2 if "both" in evenness argument.


GabrielNakamura/Dimensionality_package documentation built on Dec. 17, 2021, 9:27 p.m.