Skip to contents

Alpha diversity

Source: R/method-alphaDiv.R
alphaDiv-methods.Rd

This function returns alpha diversity values for each sample.

Usage

alphaDiv(
  data,
  method = c("shannon", "simpson", "evenness"),
  verbose = c(TRUE, FALSE)
)

# S4 method for AbundanceData
alphaDiv(
  data,
  method = c("shannon", "simpson", "evenness"),
  verbose = c(TRUE, FALSE)
)

Arguments

data

AbundanceData object

method

string defining the the alpha diversity method. Accepted values are 'shannon','simpson', and 'evenness'

verbose

boolean indicating if timed logging is desired

Value

ComputeResult object