evenness_calc: Calculates Evenness Indices

Description Usage Arguments Details Value Author(s) Examples

Description

This function calculates Shannon's, Simpson's, and/or Inverse Simpson's evenness indices.

Usage

1
evenness_calc(omicsData, index = c("shannon", "simpson"))

Arguments

omicsData

an object of the class 'seqData' reated by as.seqData.

index

a character vector stating which of the calculations to perform - "shannon" for Shannon's evenness index and/or "simpson" for Simpson's evenness index. Default is to perform both calculations.

Details

Evenness is calculated for each sample in the data. Evenness is calculated using Shannon's evenness index or Simpson's evenness index.

Value

An object of class evenRes (also a data.frame) containing the evenness value(s) for every sample in the data object.

Author(s)

Allison Thompson

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
library(mintJansson)
data(rRNA_data)
rRNA_even <- evenness_calc(omicsData = rRNA_data)
rRNA_even
summary(rRNA_even)
plot(rRNA_even)

## End(Not run)

pmartR/pmartRseq documentation built on May 25, 2019, 9:20 a.m.