Skip to content

Commit

Permalink
Global rename of supercommunity with metacommunity (and super- prefix…
Browse files Browse the repository at this point in the history
…es with meta- prefixes).
  • Loading branch information
richardreeve committed Oct 19, 2016
1 parent 7618cd9 commit 3de50d3
Show file tree
Hide file tree
Showing 15 changed files with 238 additions and 238 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

**Diversity** is a [Julia](http://www.julialang.org) package that
provides functionality for measuring alpha, beta and gamma diversity
of supercommunities (e.g. ecosystems) and their constituent
of metacommunities (e.g. ecosystems) and their constituent
subcommunities. It uses the diversity measures described in the arXiv
paper [arXiv:1404.6520 (q-bio.QM)](http://arxiv.org/abs/1404.6520),
*How to partition diversity*. It also provides a series of other
Expand Down Expand Up @@ -43,7 +43,7 @@ similarity-sensitive diversity measures (generalised from Hill, and
described in
[Leinster and Cobbold, 2012](http://www.esajournals.org/doi/abs/10.1890/10-2402.1)),
and related alpha, beta and gamma diversity measures at the level of
the supercommunity and its component subcommunities (generalised in
the metacommunity and its component subcommunities (generalised in
turn from Leinster and Cobbold, and described in
[Reeve et al, 2014](http://arxiv.org/abs/1404.6520)). The diversity
functions exist both with unicode names (e.g. ᾱ()), which are not
Expand All @@ -57,8 +57,8 @@ Accessing the main functionality in the package is simple:
```julia_skip
using Diversity
...
diversities = superdiv(NormalisedAlpha(Supercommunity(proportions, Z)), [0, 1, 2, Inf])
diversity = subdiv(RawRho(Supercommunity(proportions, Z)), 2)
diversities = metadiv(NormalisedAlpha(Metacommunity(proportions, Z)), [0, 1, 2, Inf])
diversity = subdiv(RawRho(Metacommunity(proportions, Z)), 2)
```

The package also provides sub-modules with other diversity measures:
Expand All @@ -69,10 +69,10 @@ Many existing ecological diversity measures can be derived from our
diversity measures, and so we provide them in the Diversity.Ecology
submodule along with generalised versions of them that relate to our
general measures of alpha, beta and gamma diversity at subcommunity
and supercommunity levels. The generalisations of species richness,
and metacommunity levels. The generalisations of species richness,
Shannon entropy and Simpson's index are the only standard measures we
are aware of whose subcommunity components sum directly to the
corresponding supercommunity measure (although note that Simpson's
corresponding metacommunity measure (although note that Simpson's
index decreases for increased diversity, so small components are more
diverse). Documentation for these diversity measures can be found
[here](http://diversityjl.readthedocs.org/en/stable/ecology/).
Expand Down
8 changes: 4 additions & 4 deletions doc/diversity.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ similarity-sensitive diversity measures (generalised from Hill, and
described in
[Leinster and Cobbold, 2012](http://www.esajournals.org/doi/abs/10.1890/10-2402.1)),
and related alpha, beta and gamma diversity measures at the level of
the supercommunity and its component subcommunities (generalised in
the metacommunity and its component subcommunities (generalised in
turn from Leinster and Cobbold, and described in
[Reeve et al, 2014](http://arxiv.org/abs/1404.6520)). 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 ```supercommunityDiversity()```
```subcommunityDiversity()``` and ```metacommunityDiversity()```
values for each measure, a general ```diversity()``` function for
extract any diversity measure at a series of scales.

Expand All @@ -23,6 +23,6 @@ Accessing the main functionality in the package is simple:
```julia_skip
using Diversity
...
diversities = supercommunityDiversity(NormalisedAlpha(Ecosystem(proportions, Z)), [0, 1, 2, Inf])
diversity = supercommunityDiversity(RawRho(Ecosystem(proportions, Z)), 2)
diversities = metacommunityDiversity(NormalisedAlpha(Metacommunity(proportions, Z)), [0, 1, 2, Inf])
diversity = metacommunityDiversity(RawRho(Metacommunity(proportions, Z)), 2)
```
142 changes: 71 additions & 71 deletions src/Diversity.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,33 @@ similarity-sensitive diversity measures (generalised from Hill, and
described in
[Leinster and Cobbold, 2012](http://www.esajournals.org/doi/abs/10.1890/10-2402.1)),
and related alpha, beta and gamma diversity measures at the level of
the supercommunity and its component subcommunities (generalised in
the metacommunity and its component subcommunities (generalised in
turn from Leinster and Cobbold, and described in
[Reeve et al, 2014](http://arxiv.org/abs/1404.6520)). 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 ```supercommunityDiversity()```
```subcommunityDiversity()``` and ```metacommunityDiversity()```
values for each measure, a general ```diversity()``` function for
extract any diversity measure at a series of scales.
"""
module Diversity

include("Supercommunity.jl")
include("Metacommunity.jl")
export Subcommunities, Onecommunity
export Similarity, Unique, Species, Taxonomy, MatrixSimilarity
export Supercommunity
export Metacommunity
export getabundance, getweight
export getsimilarity, getordinariness!, getsuperordinariness!
export inddiv, subdiv, superdiv
export getsimilarity, getordinariness!, getmetaordinariness!
export inddiv, subdiv, metadiv

include("EffectiveNumbers.jl")
export qD, qDZ

include("DiversityMeasure.jl")
export DiversityLevel
export individualDiversity, subcommunityDiversity, supercommunityDiversity
export individualDiversity, subcommunityDiversity, metacommunityDiversity

export RawAlpha, NormalisedAlpha
export RawBeta, NormalisedBeta, RawRho, NormalisedRho
Expand All @@ -55,101 +55,101 @@ export diversity
@deprecate(Dρ, subcommunityrho)
@deprecate(Dγ̄, subcommunitygammabar)
@deprecate(Dγ, subcommunitygamma)
@deprecate(DĀ, supercommunityAbar)
@deprecate(DA, supercommunityA)
@deprecate(DB̄, supercommunityBbar)
@deprecate(DB, supercommunityB)
@deprecate(DR̄, supercommunityRbar)
@deprecate(DR, supercommunityR)
@deprecate(DḠ, supercommunityGbar)
@deprecate(DG, supercommunityG)
@deprecate(DĀ, metacommunityAbar)
@deprecate(DA, metacommunityA)
@deprecate(DB̄, metacommunityBbar)
@deprecate(DB, metacommunityB)
@deprecate(DR̄, metacommunityRbar)
@deprecate(DR, metacommunityR)
@deprecate(DḠ, metacommunityGbar)
@deprecate(DG, metacommunityG)

## Deprecate ecosystem-related names
@deprecate(ecosystemA, supercommunityA)
@deprecate(ecosystemAbar, supercommunityAbar)
@deprecate(ecosystemB, supercommunityB)
@deprecate(ecosystemBbar, supercommunityBbar)
@deprecate(ecosystemR, supercommunityR)
@deprecate(ecosystemRbar, supercommunityRbar)
@deprecate(ecosystemG, supercommunityG)
@deprecate(ecosystemGbar, supercommunityGbar)
@deprecate(ecosystemA, metacommunityA)
@deprecate(ecosystemAbar, metacommunityAbar)
@deprecate(ecosystemB, metacommunityB)
@deprecate(ecosystemBbar, metacommunityBbar)
@deprecate(ecosystemR, metacommunityR)
@deprecate(ecosystemRbar, metacommunityRbar)
@deprecate(ecosystemG, metacommunityG)
@deprecate(ecosystemGbar, metacommunityGbar)

## Deprecate all-in-one names, as we divide calculation into type of
## diversity and scale
@deprecate(subcommunityalphabar(pop, Z, qs),
subcommunityDiversity(ᾱ(Supercommunity(pop, Z)), qs))
subcommunityDiversity(ᾱ(Metacommunity(pop, Z)), qs))
@deprecate(subcommunityalpha(pop, Z, qs),
subcommunityDiversity(α(Supercommunity(pop, Z)), qs))
subcommunityDiversity(α(Metacommunity(pop, Z)), qs))
@deprecate(subcommunitybetabar(pop, Z, qs),
subcommunityDiversity(β̄(Supercommunity(pop, Z)), qs))
subcommunityDiversity(β̄(Metacommunity(pop, Z)), qs))
@deprecate(subcommunitybeta(pop, Z, qs),
subcommunityDiversity(β(Supercommunity(pop, Z)), qs))
subcommunityDiversity(β(Metacommunity(pop, Z)), qs))
@deprecate(subcommunityrhobar(pop, Z, qs),
subcommunityDiversity(ρ̄(Supercommunity(pop, Z)), qs))
subcommunityDiversity(ρ̄(Metacommunity(pop, Z)), qs))
@deprecate(subcommunityrho(pop, Z, qs),
subcommunityDiversity(ρ(Supercommunity(pop, Z)), qs))
subcommunityDiversity(ρ(Metacommunity(pop, Z)), qs))
@deprecate(subcommunitygammabar(pop, Z, qs),
subcommunityDiversity(γ̄(Supercommunity(pop, Z)), qs))
subcommunityDiversity(γ̄(Metacommunity(pop, Z)), qs))
@deprecate(subcommunitygamma(pop, Z, qs),
subcommunityDiversity(γ(Supercommunity(pop, Z)), qs))
@deprecate(supercommunityAbar(pop, Z, qs),
supercommunityDiversity(ᾱ(Supercommunity(pop, Z)), qs))
@deprecate(supercommunityA(pop, Z, qs),
supercommunityDiversity(α(Supercommunity(pop, Z)), qs))
@deprecate(supercommunityBbar(pop, Z, qs),
supercommunityDiversity(β̄(Supercommunity(pop, Z)), qs))
@deprecate(supercommunityB(pop, Z, qs),
supercommunityDiversity(β(Supercommunity(pop, Z)), qs))
@deprecate(supercommunityRbar(pop, Z, qs),
supercommunityDiversity(ρ̄(Supercommunity(pop, Z)), qs))
@deprecate(supercommunityR(pop, Z, qs),
supercommunityDiversity(ρ(Supercommunity(pop, Z)), qs))
@deprecate(supercommunityG(pop, Z, qs),
supercommunityDiversity(γ(Supercommunity(pop, Z)), qs))
subcommunityDiversity(γ(Metacommunity(pop, Z)), qs))
@deprecate(metacommunityAbar(pop, Z, qs),
metacommunityDiversity(ᾱ(Metacommunity(pop, Z)), qs))
@deprecate(metacommunityA(pop, Z, qs),
metacommunityDiversity(α(Metacommunity(pop, Z)), qs))
@deprecate(metacommunityBbar(pop, Z, qs),
metacommunityDiversity(β̄(Metacommunity(pop, Z)), qs))
@deprecate(metacommunityB(pop, Z, qs),
metacommunityDiversity(β(Metacommunity(pop, Z)), qs))
@deprecate(metacommunityRbar(pop, Z, qs),
metacommunityDiversity(ρ̄(Metacommunity(pop, Z)), qs))
@deprecate(metacommunityR(pop, Z, qs),
metacommunityDiversity(ρ(Metacommunity(pop, Z)), qs))
@deprecate(metacommunityG(pop, Z, qs),
metacommunityDiversity(γ(Metacommunity(pop, Z)), qs))

@deprecate(subcommunityalphabar(pop, qs),
subcommunityDiversity(ᾱ(Supercommunity(pop)), qs))
subcommunityDiversity(ᾱ(Metacommunity(pop)), qs))
@deprecate(subcommunityalpha(pop, qs),
subcommunityDiversity(α(Supercommunity(pop)), qs))
subcommunityDiversity(α(Metacommunity(pop)), qs))
@deprecate(subcommunitybetabar(pop, qs),
subcommunityDiversity(β̄(Supercommunity(pop)), qs))
subcommunityDiversity(β̄(Metacommunity(pop)), qs))
@deprecate(subcommunitybeta(pop, qs),
subcommunityDiversity(β(Supercommunity(pop)), qs))
subcommunityDiversity(β(Metacommunity(pop)), qs))
@deprecate(subcommunityrhobar(pop, qs),
subcommunityDiversity(ρ̄(Supercommunity(pop)), qs))
subcommunityDiversity(ρ̄(Metacommunity(pop)), qs))
@deprecate(subcommunityrho(pop, qs),
subcommunityDiversity(ρ(Supercommunity(pop)), qs))
subcommunityDiversity(ρ(Metacommunity(pop)), qs))
@deprecate(subcommunitygammabar(pop, qs),
subcommunityDiversity(γ̄(Supercommunity(pop)), qs))
subcommunityDiversity(γ̄(Metacommunity(pop)), qs))
@deprecate(subcommunitygamma(pop, qs),
subcommunityDiversity(γ(Supercommunity(pop)), qs))
@deprecate(supercommunityAbar(pop, qs),
supercommunityDiversity(ᾱ(Supercommunity(pop)), qs))
@deprecate(supercommunityA(pop, qs),
supercommunityDiversity(α(Supercommunity(pop)), qs))
@deprecate(supercommunityBbar(pop, qs),
supercommunityDiversity(β̄(Supercommunity(pop)), qs))
@deprecate(supercommunityB(pop, qs),
supercommunityDiversity(β(Supercommunity(pop)), qs))
@deprecate(supercommunityRbar(pop, qs),
supercommunityDiversity(ρ̄(Supercommunity(pop)), qs))
@deprecate(supercommunityR(pop, qs),
supercommunityDiversity(ρ(Supercommunity(pop)), qs))
@deprecate(supercommunityG(pop, qs),
supercommunityDiversity(γ(Supercommunity(pop)), qs))
subcommunityDiversity(γ(Metacommunity(pop)), qs))
@deprecate(metacommunityAbar(pop, qs),
metacommunityDiversity(ᾱ(Metacommunity(pop)), qs))
@deprecate(metacommunityA(pop, qs),
metacommunityDiversity(α(Metacommunity(pop)), qs))
@deprecate(metacommunityBbar(pop, qs),
metacommunityDiversity(β̄(Metacommunity(pop)), qs))
@deprecate(metacommunityB(pop, qs),
metacommunityDiversity(β(Metacommunity(pop)), qs))
@deprecate(metacommunityRbar(pop, qs),
metacommunityDiversity(ρ̄(Metacommunity(pop)), qs))
@deprecate(metacommunityR(pop, qs),
metacommunityDiversity(ρ(Metacommunity(pop)), qs))
@deprecate(metacommunityG(pop, qs),
metacommunityDiversity(γ(Metacommunity(pop)), qs))

## Deprecate anything related to ϵ as it has been replaced by ρ̄
@deprecate(subcommunityepsilon, Dρ̄)
@deprecate(Dϵ, Dρ̄)
@deprecate(ecosystemE, supercommunityRbar)
@deprecate(supercommunityE, supercommunityRbar)
@deprecate(DE, supercommunityRbar)
@deprecate(ecosystemE, metacommunityRbar)
@deprecate(metacommunityE, metacommunityRbar)
@deprecate(DE, metacommunityRbar)

"""
The **Diversity.Ecology** module replicates old ecological
diversity measures and generalised versions of them that relate to our
general measures of alpha, beta and gamma diversity at subcommunity
and supercommunity levels. The generalisations of the richness, Shannon
and metacommunity levels. The generalisations of the richness, Shannon
and Simpson are the only standard measures we are aware of whose
subcommunity components sum directly to the corresponding ecosystem
measure (although note that Simpson's index decreases for increased
Expand Down

0 comments on commit 3de50d3

Please sign in to comment.