betavolume: Load a Matrix corresponds to metacommunity composition

View source: R/betavolume.R

betavolumeR Documentation

Load a Matrix corresponds to metacommunity composition

Description

This function loads a file as a matrix. It assumes that columns correspond to local communities (plots or patches) while the columns correspond to species. The matrix entries correspond to species property (e.g, presence/absence).

Usage

betavolume(
  meta_composition,
  preprocess = T,
  weights = F,
  remove_unique = F,
  hypervolume_method,
  compressed_angle = 1,
  dim_threshold = 10,
  sparsity = F
)

Arguments

meta_composition

metacommunity composition

preprocess

Whether weights and remove_unique should be executed

weights

whether non-unique compositions should be weighted

remove_unique

whether unique compositions should be removed

hypervolume_method

which method to estimate the hypervolume

compressed_angle

how much the original hypervolume is changed by the similarity matrix

dim_threshold

the threshold of which default hypervolume_method is used

sparsity

whether the meta_composition is encoded as a sparse matrix

Value

the value of the geometric measure of beta_diversity


clsong/BetaVolume documentation built on Jan. 4, 2023, 1:07 p.m.