Feature request: Table of diversity indices with index properties

[vmikk]

It would be beneficial to introduce a (machine-readable) table or list of diversity indices supported by Biodiverse, detailing the properties of each index, to assist in automatically selecting appropriate visualization color schemes.

The table may show:

• Name of the index (as in Wiki:Indices)
• Properties of the index values:
  • Fixed range: Values that are constrained within a specific range (e.g., 0-1, as with SIMPSON_D);
  • Only non-negative: Values that can be 0 or positive (e.g., RICHNESS_ALL);
  • Unbounded range: Values that can stretch from negative to positive infinity (like SES values).
  • Categorical: Indices with fixed gradation or categories (CANAPE)
• (?) Recommendation for visualization: Based on the properties, a suggested color scheme or visualization guideline:
  • Diverging gradient
  • Sequential palette
  • Qualitative palette

[shawnlaffan]

This can use the existing metadata infrastructure. Machine readability can be via export to JSON.

The main consideration is the notation to use. Possibly something like the standard bounds notation for continuous values, e.g. [0,1], (-Inf,+Inf). Or perhaps lower: 0, upper: 1 with other flags for inclusive/exclusive. Categorical data would just be a hash/dict: 0: Non-sig, 1: Neo, 2: Mixed, 3: Palaeo.

Divergent, sequential and categorical would be additional fields.

[shawnlaffan]

Metadata flags for ratio and divergent distributions were added in #893

[shawnlaffan]

Metadata was updated in #897

[shawnlaffan]

Support for categorical indices is in PR #899