joshwlambert / DAISIEprep

Extracts phylogenetic island community data from phylogenetic trees
https://joshwlambert.github.io/DAISIEprep
GNU General Public License v3.0
6 stars 3 forks source link

Consider switching endemicity to state encoding #8

Closed TheoPannetier closed 2 years ago

TheoPannetier commented 2 years ago

As of now, following the Tutorial and the MuSSE example, we have the following encoding:

This is arbitrary, works well. I have hard-encoded the convention into all_endemicity_status().

However, GeoSSE requires a different encoding:

The output of BioGeoBEARS also appears to follow this convention. I'll switch the current convention to this one to avoid the coexistence of two encodings and the risk of confusion.

TheoPannetier commented 2 years ago

Done, values switched!

TheoPannetier commented 2 years ago

Correction: GeoSSE requires states 0, 1, 2, with 0 the widespread state. MuSSE requires states 1, 2, 3 (any can be the widespread, since it's considered as just a different state). BioGeoBEARS follows the convention 1, 2, 3 with 3 the widespread state in its output.

Because of this inconsistency I can't make a single switch for all models. I'll add an argument model to endemicity_to_states to return the desired output for MuSSE / GeoSSE

TheoPannetier commented 2 years ago

Done