variety {diverse}

Variety or Richness

Description

Computes the variety (number of distinct types) or simple diversity of an entity. It is also known as richness.

Usage

variety(data, sort = TRUE, decreasing = TRUE, category_row = FALSE)

Arguments

data

A numeric matrix with entities i in the rows and categories j in the columns. Cells show the respective value (value of abundance) of entity i in the category j. It can also be a transpose of the previous matrix, that is, a matrix with categories in the rows and entities in the columns. Yet in that case, the argument "category_row" has to be set to TRUE. The matrix must include names for the rows and the columns. The argument "data", also accepts a dataframe with three columns in the following order: entity, category and value.

sort

Indicates whether results should be ordered or not. Define it to FALSE to avoid ordering.

decreasing

If argument "sort" is set to TRUE, this argument indicates descending order. The default value is TRUE.

category_row

A flag to indicate that categories are in the rows. The analysis assumes that the categories are in the columns of the matrix. If the categories are in the rows and the entities in the columns, then the argument "category_row" has to be set to TRUE. The default value is FALSE.

Value

A dataframe with values of variety for each entity.

Examples

variety(data=pantheon)
variety(data=pantheon, sort=FALSE)