get_all_diversities: Compute all diversity flows associated to different random...

In Lamarche-Perrin/triversity: Diversity Measures on Multipartite Graphs

Description

get_all_diversities builds on get_diversity_from_path to compute the diversity values associated to all possible paths of a given length between the different parts of the input multipartite graph.

Usage

get_all_diversities(graph, length = 2, cycles = TRUE, type = c("mean",
  "collective"), order = NULL, measure = NULL)

Arguments

graph	A multipartite graph obtained by calling the get_multipartite function.
length	A positive integer giving the maximal length of the computed paths.
cycles	A boolean value indicating if the diversity associated to paths containing cycles should be computed.
type	A vector specifying the types of diversity to compute, among 'mean' and 'collective'. See get_diversity_from_path.
order	A vector of positive floats (possibly including Inf) giving the orders of the diversity measures to be computed. If neither order nor measure is specified, a predefined list of 8 diversity measures is computed.
measure	A vector of strings giving the names of the diversity measures to compute. Possible values are richness, entropy, herfindahl, and bergerparker.

Value

A dataframe summarising all the computed diversities.

Examples

data (tripartite_example)
graph <- get_multipartite (data=tripartite_example)
get_all_diversities (graph)

Lamarche-Perrin/triversity documentation built on May 22, 2019, 12:36 p.m.