Diversity.jl
A package for measuring and partitioning diversity
The main Diversity package provides basic numbers-equivalent diversity measures (described in Hill, 1973), similarity-sensitive diversity measures (generalised from Hill, and described in Leinster and Cobbold, 2012), and related alpha, beta and gamma diversity measures at the level of the metacommunity and its component subcommunities (generalised in turn from Leinster and Cobbold, and described in Reeve et al, 2014). The diversity functions exist both with unicode names (e.g. ᾱ()), which are not automatically exported (as we feel they are too short) and with matching longer ASCII names (e.g. NormalisedAlpha()), which are. We also provide functions to calculate appropriate subdiv() and metadiv() values for each measure, a general diversity() function for extract any diversity measure at a series of scales.
Accessing the main functionality in the package is simple:
julia> # Load the package into R
using Diversity
julia> # Example population
pop = [1 1 0; 2 0 0; 3 1 4];
julia> pop = pop ./ sum(pop);
julia> # Create Metacommunity object
meta = Metacommunity(pop);
julia> diversities = norm_meta_alpha(meta, [0, 1, 2, Inf])
4×8 DataFrame
Row │ div_type measure q type_level type_name partition_level partition_name diversity
│ String String Float64 String String String String Float64
─────┼───────────────────────────────────────────────────────────────────────────────────────────────────────
1 │ Unique NormalisedAlpha 0.0 types metacommunity 2.16667
2 │ Unique NormalisedAlpha 1.0 types metacommunity 1.86121
3 │ Unique NormalisedAlpha 2.0 types metacommunity 1.63636
4 │ Unique NormalisedAlpha Inf types metacommunity 1.0
julia> Z = [1.0 0 0; 0 1 1; 1 1 1];
julia> meta_z = Metacommunity(pop, Z);
julia> rho = RawRho(meta_z);
julia> redundancies = subdiv(rho, 2)
3×8 DataFrame
Row │ div_type measure q type_level type_name partition_level partition_name diversity
│ String String Int64 String String String String Float64
─────┼────────────────────────────────────────────────────────────────────────────────────────────────
1 │ Arbitrary Z RawRho 2 types subcommunity 1 2.0
2 │ Arbitrary Z RawRho 2 types subcommunity 2 3.0
3 │ Arbitrary Z RawRho 2 types subcommunity 3 3.0Diversity.Diversity — Module
Diversity packageThe main Diversity package provides basic numbers-equivalent diversity measures (described in Hill, 1973), similarity-sensitive diversity measures (generalised from Hill, and described in Leinster and Cobbold, 2012), and related alpha, beta and gamma diversity measures at the level of the metacommunity and its component subcommunities (generalised in turn from Leinster and Cobbold, and described in Reeve et al, 2014). The diversity functions exist both with unicode names (e.g. ᾱ()), which are not automatically exported (as we feel they are too short) and with matching longer ASCII names (e.g. NormalisedAlpha()), which are. We also provide functions to calculate appropriate subcommunityDiversity() and metacommunityDiversity() values for each measure, a general diversity() function for extract any diversity measure at a series of scales.
Diversity.individualDiversity — Constant
Generates the function to calculate individual diversities
Generates the function to calculate individual diversities for a series of orders, represented as a vector of qs.
Arguments:
dm: DiversityMeasure
Returns:
- Function which takes a single number or vector of values of parameter q, and returns the individual diversities for those values.
Diversity.metacommunityDiversity — Constant
Generates the function to calculate metacommunity diversity
Generates the function to calculate metacommunity diversity for a series of orders, represented as a vector of qs.
Arguments:
dm: DiversityMeasure
Returns:
- Function which takes a single number or vector of values of parameter q, and returns the metacommunity diversities for those values.
Diversity.subcommunityDiversity — Constant
Generates the function to calculate subcommunity diversity
Generates the function to calculate subcommunity diversity for a series of orders, represented as a vector of qs.
Arguments:
dm: DiversityMeasure
Returns:
- Function which takes a single number or vector of values of parameter q, and returns the subcommunity diversities for those values.
Diversity.DiversityLevel — Type
Enumeration of levels that can exist / be calculated for a metacommunity.
Diversity.DiversityMeasure — Type
DiversityMeasureThis type is the abstract supertype of all diversity measure types. DiversityMeasure subtypes allow you to calculate and cache any kind of diversity of a metacommunity.
Diversity.Gamma — Type
GammaCalculates gamma diversity (γ) of all of the individuals in a metacommunity, and caches them for subsequent analysis. This is a subtype of PowerMeanMeasure, meaning that all composite diversity measures are simple powermeans of the individual measures.
Constructor arguments:
meta: a Metacommunity
Diversity.GeneralTypes — Type
GeneralTypes{FP, M, LABELS}An AbstractTypes subtype with a general similarity matrix. This subtype simply holds a matrix with similarities between individuals.
Members:
zA two-dimensional matrix representing similarity between
individuals.
namesVector of type names.
Diversity.GeneralTypes — Method
GeneralTypes(zmatrix::M)
GeneralTypes(zmatrix::M, names::LABELS)Constructors for GeneralTypes. Creates an instance of the GeneralTypes class, with an arbitrary zmatrix similarity matrix and an optional vector of type names.
Diversity.Metacommunity — Type
Metacommunity{FP, ARaw, AProcessed, Part, Sim}Metacommunity type, representing a whole metacommunity containing a single community or a collection of subcommunities. The metacommunity of individuals may be further partitioned into smaller groups. For instance this may be an ecosystem, which consists of a series of subcommunities. The AbstractPartition subtype within it stores relative abundances of different types, e.g. species, and also allows for similarity between individuals.
Constructor:
Metacommunity(abundances::AbstractArray, part::AbstractPartition, types::AbstractTypes)
Members:
abundancesthe abundance matrix for the metacommunity.partitionthe instance of the AbstractPartition subtype, containing the subcommunities.typesThe instance of the AbstractTypes subtype, from which similarities between individuals can be calculated.ordinarinessA cache of the ordinariness of the individuals in the Partition. Should only be accessed through getordinariness!(::Metacommunity), which will populate the cache if it has not yet been calculated.
Diversity.NormalisedAlpha — Type
NormalisedAlphaCalculates normalised alpha diversity (ᾱ) of all of the individuals in a metacommunity, and caches them for subsequent analysis. This is a subtype of PowerMeanMeasure, meaning that all composite diversity measures are simple powermeans of the individual measures.
Constructor arguments:
meta: a Metacommunity
Diversity.NormalisedBeta — Type
NormalisedBetaCalculates normalised beta diversity (β̄) of all of the individuals in a metacommunity, and caches them for subsequent analysis. This is a subtype of RelativeEntropyMeasure, meaning that subcommunity and type composite diversity measures are relative entropies, and their composite types are powermeans of those measures.
Constructor arguments:
meta: a Metacommunity
Diversity.NormalisedRho — Type
NormalisedRhoCalculates redundancy (ρ̄, normalised beta diversity) of all of the individuals in a metacommunity, and caches them for subsequent analysis. This is a subtype of PowerMeanMeasure, meaning that all composite diversity measures are simple powermeans of the individual measures.
Constructor arguments:
meta: a Metacommunity
Diversity.Onecommunity — Type
OnecommunityAbstractPartition subtype containing only one subcommunity.
Diversity.PowerMeanMeasure — Type
PowerMeanMeasureThis abstract DiversityMeasure subtype is the supertype of all diversity measures which are straight power means. PowerMeanMeasure subtypes allow you to calculate and cache any kind of diversity of a metacommunity.
Diversity.RawAlpha — Type
RawAlphaCalculates raw alpha diversity (α) of all of the individuals in a metacommunity, and caches them for subsequent analysis. This is a subtype of PowerMeanMeasure, meaning that all composite diversity measures are simple powermeans of the individual measures.
Constructor arguments:
meta: a Metacommunity
Diversity.RawBeta — Type
RawBetaCalculates distinctiveness (β, raw beta diversity) of all of the individuals in a metacommunity, and caches them for subsequent analysis. This is a subtype of RelativeEntropyMeasure, meaning that subcommunity and type composite diversity measures are relative entropies, and their composite types are powermeans of those measures.
Constructor arguments:
meta: a Metacommunity
Diversity.RawRho — Type
RawRhoCalculates redundancy (ρ, raw beta diversity) of all of the individuals in a metacommunity, and caches them for subsequent analysis. This is a subtype of PowerMeanMeasure, meaning that all composite diversity measures are simple powermeans of the individual measures.
Constructor arguments:
meta: a Metacommunity
Diversity.RelativeEntropyMeasure — Type
RelativeEntropyMeasureThis abstract DiversityMeasure subtype is the supertype of all diversity measures which are relative entropy-based diversity measures. RelativeEntropyMeasure subtypes allow you to calculate and cache any kind of diversity of a metacommunity.
Diversity.Species — Type
SpeciesA subtype of AbstractTypes where all species are completely distinct. This type is the simplest AbstractTypes subtype, which identifies all species as unique and completely distinct from each other.
Diversity.Subcommunities — Type
Subcommunities(num)AbstractPartition subtype with multiple subcommunities.
Diversity.Taxonomy — Type
TaxonomyA subtype of AbstractTypes with similarity between related taxa, creating taxonomic similarity matrices.
Diversity.UniqueTypes — Type
UniqueTypesA subtype of AbstractTypes where all individuals are completely distinct. This type is the simplest AbstractTypes subtype, which identifies all individuals as unique and completely distinct from each other.
Diversity.addedoutputcols — Function
addedoutputcols(m::AbstractAssemblage)
addedoutputcols(t::AbstractTypes)Returns the name of any additional columns needed to disambiguate the diversity type used.
Diversity.calcsimilarity — Method
calcsimilarity(t::AbstractTypes, scale::Real)Retrieves (and possibly calculates) a similarity matrix from t.
Diversity.countsubcommunities — Function
countsubcommunities(m::AbstractAssemblage)
countsubcommunities(p::AbstractPartition)Returns number of subcommunities in an AbstractPartition object or the AbstractAssemblage containing it.
Diversity.counttypes — Function
counttypes(m::AbstractAssemblage[, raw::Bool = false])
counttypes(t::AbstractTypes[, raw::Bool = false])Returns number of types in an AbstractTypes object or the AbstractAssemblage containing it. raw determines whether to count the number of raw or processed types, which varies, for instance, when the types are determined by a phylogeny.
Diversity.diversity — Method
Calculates subcommunity and metacommunity diversities
Calculates any diversity of a Metacommunity for a series of orders, repesented as one or a vector of qs.
Arguments:
dls: an iterable collection of DiversityLevelsdms: an iterable collection of DiversityMeasuresmeta: a Metacommunityqs: single number or vector of values of parameter q
Returns:
A vector containing all of the diversity levels of all of the requested diversities.
Diversity.getASCIIName — Method
getASCIIName(dm::DiversityMeasure)Return the ASCII name of the DiversityMeasure
Arguments:
dm: DiversityMeasure
Returns:
- String containing simple ASCII name of DiversityMeasure
Diversity.getFullName — Function
getFullName(dm::DiversityMeasure)Return the full name of the DiversityMeasure.
Arguments:
dm: DiversityMeasure
Returns:
- String containing full descriptive name of DiversityMeasure
Diversity.getName — Function
getName(dm::DiversityMeasure)Return the character corresponding to the DiversityMeasure.
Arguments:
dm: DiversityMeasure
Returns:
- String containing unicode (greek) name of DiversityMeasure.
Diversity.getabundance — Function
getabundance(m::AbstractAssemblage, raw::Bool)Returns the abundances array of the metacommunity.
Diversity.getaddedoutput — Function
getaddedoutput(::AbstractTypes)Returns the contents of any additional columns to be added to outputs.
Diversity.getdiversityname — Function
getdiversityname(m::AbstractAssemblage)
getdiversityname(t::AbstractTypes)Returns the name of the diversity type used.
Diversity.getmetaabundance — Function
getmetaabundance(m::AbstractAssemblage)Returns the metacommunity abundances of the metacommunity.
Diversity.getmetaordinariness! — Method
getmetaordinariness!(m::AbstractAssemblage)Returns (and possibly calculates) the ordinariness of the metacommunity as a whole.
Diversity.getordinariness! — Method
getordinariness!(m::AbstractAssemblage)Returns (and possibly calculates) the ordinariness array of the subcommunities.
Diversity.getpartition — Method
getpartition(m::AbstractAssemblage)Returns the AbstractPartition component of the metacommunity.
Diversity.getsubcommunitynames — Function
getsubcommunitynames(m::AbstractAssemblage)
getsubcommunitynames(p::AbstractPartition)Returns the names of the subcommunities in an AbstractPartition object or the AbstractAssemblage containing it.
Diversity.gettypenames — Function
gettypenames(m::AbstractAssemblage[, raw::Bool = false])
gettypenames(t::AbstractTypes[, raw::Bool = false])Returns the names of the types of the AbstractTypes object or the AbstractAssemblage containing it. raw determines whether to count the number of raw or processed types, which varies, for instance, when the types are determined by a phylogeny.
Diversity.gettypes — Method
gettypes(m::AbstractAssemblage)Returns the AbstractTypes component of the metacommunity.
Diversity.getweight — Method
getweight(m::AbstractAssemblage)Returns the subcommunity weights of the metacommunity.
Diversity.hassimilarity — Function
hassimilarity(t::AbstractAssemblage)
hassimilarity(t::AbstractThings)Is there similarity of some non-trivial type in the object?
Diversity.inddiv — Function
inddiv(measure::DiversityMeasure, q::Real)
inddiv(measure::DiversityMeasure, qs::AbstractVector{Real})Takes a diversity measure and single order or vector of orders, and returns a DataFrame containing the individual diversities for those values.
Arguments:
dm: DiversityMeasureq/qs: a single order or a vector of orders
Returns:
- Returns individual diversities of
dmfor a single orderqor a vector of orderqs.
Diversity.metadiv — Function
metadiv(measure::DiversityMeasure, q::Real)
metadiv(measure::DiversityMeasure, qs::AbstractVector{Real})Takes a diversity measure and single order or vector of orders, and calculates and returns the metacommunity diversities for those values.
Arguments:
dm: DiversityMeasureq/qs: a single order or a vector of orders
Returns:
- Returns metacommunity diversities of
dmfor a single orderqor a vector of orderqs.
Diversity.qD — Function
qDCalculates Hill / naive-similarity diversity of order(s) qs of a population with given relative proportions.
Arguments:
proportions: relative proportions of different types in populationqs: single number or vector of orders of diversity measurement
Returns:
- Diversity of order qs (single number or vector of diversities)
Diversity.qDZ — Function
qDZCalculates Leinster-Cobbold / similarity-sensitive diversity of >= 1 order(s) qs of a population with given relative proportions, and similarity matrix Z.
Arguments:
proportions: relative proportions of different types in a populationqs: single number or vector of orders of diversity measurementZ: similarity matrix
Returns:
Diversity of order qs (single number or vector of diversities)
Diversity.subdiv — Function
subdiv(measure::DiversityMeasure, q::Real)
subdiv(measure::DiversityMeasure, qs::AbstractVector{Real})Takes a diversity measure and single order or vector of orders, and calculates and returns the subcommunity diversities for those values.
Arguments:
dm: DiversityMeasureq/qs: a single order or a vector of orders
Returns:
- Returns subcommunity diversities of
dmfor a single orderqor a vector of orderqs.
Diversity.ShortNames — Module
Diversity.ShortNames submoduleWe do not directly export ᾱ, α, β̄, β, ρ̄, ρ, γ as they're too short. γ actually can't be exported like this - it'll always just be Shortnames.γ, so we export Γ instead.
All of these can only be accessed via Diversity.ShortNames.
Private functions in module Diversity:
Diversity._getmeta — Method
_getmeta(dm::DiversityMeasure)Return the metacommunity belonging to the DiversityMeasure.
Diversity.powermean — Function
powermeanCalculates the weighted powermean of a series of numbers
Calculates orderth power mean of values, weighted by weights. By default, weights are equal and order is 1, so this is just the arithmetic mean.
Arguments:
values: values for which to calculate meanorder[s]: order[s] of power meanweights: weights of elements, normalised to 1 inside function
Returns:
- weighted power mean(s)
Diversity.APIDiversity.DiversityDiversity.EcologyDiversity.HillDiversity.JostDiversity.ShortNamesDiversity.individualDiversityDiversity.metacommunityDiversityDiversity.subcommunityDiversityDiversity.API.AbstractMetacommunityDiversity.API.AbstractPartitionDiversity.API.AbstractTypesDiversity.DiversityLevelDiversity.DiversityMeasureDiversity.GammaDiversity.GeneralTypesDiversity.GeneralTypesDiversity.MetacommunityDiversity.NormalisedAlphaDiversity.NormalisedBetaDiversity.NormalisedRhoDiversity.OnecommunityDiversity.PowerMeanMeasureDiversity.RawAlphaDiversity.RawBetaDiversity.RawRhoDiversity.RelativeEntropyMeasureDiversity.SpeciesDiversity.SubcommunitiesDiversity.TaxonomyDiversity.UniqueTypesDiversity.API._addedoutputcolsDiversity.API._calcabundanceDiversity.API._calcordinarinessDiversity.API._calcsimilarityDiversity.API._countsubcommunitiesDiversity.API._counttypesDiversity.API._getabundanceDiversity.API._getaddedoutputDiversity.API._getdiversitynameDiversity.API._getmetaabundanceDiversity.API._getmetaordinariness!Diversity.API._getordinariness!Diversity.API._getpartitionDiversity.API._getscaleDiversity.API._getsubcommunitynamesDiversity.API._gettypenamesDiversity.API._gettypesDiversity.API._getweightDiversity.API.floattypesDiversity.API.mcmatchDiversity.API.typematchDiversity.Ecology.generalisedjaccardDiversity.Ecology.generalisedrichnessDiversity.Ecology.generalisedshannonDiversity.Ecology.generalisedsimpsonDiversity.Ecology.gowerDiversity.Ecology.jaccardDiversity.Ecology.pielouDiversity.Ecology.richnessDiversity.Ecology.shannonDiversity.Ecology.simpsonDiversity.Hill.hillnumberDiversity.Jost.jostalphaDiversity.Jost.jostbetaDiversity._getmetaDiversity.addedoutputcolsDiversity.calcsimilarityDiversity.countsubcommunitiesDiversity.counttypesDiversity.diversityDiversity.getASCIINameDiversity.getFullNameDiversity.getNameDiversity.getabundanceDiversity.getaddedoutputDiversity.getdiversitynameDiversity.getmetaabundanceDiversity.getmetaordinariness!Diversity.getordinariness!Diversity.getpartitionDiversity.getsubcommunitynamesDiversity.gettypenamesDiversity.gettypesDiversity.getweightDiversity.hassimilarityDiversity.inddivDiversity.metadivDiversity.powermeanDiversity.qDDiversity.qDZDiversity.subdiv