phyloref / klados

A curation tool to edit test cases for the Phyloref curation workflow
http://www.phyloref.org/klados/
MIT License
2 stars 1 forks source link

Add additional example files #232

Closed gaurav closed 1 year ago

gaurav commented 2 years ago

In PR #230, I removed the following example files:

This leaves us with a single small example file, Brochu 2003. This issue tracks us adding additional example files (probably from the Clade Ontology) to Klados. Ideally, they should demonstrate specimen identifiers (like Fisher et al did) or apomorphy-based phyloreferences. Using files from the Clade Ontology will almost certainly be easier than attempting to convert these v0.2.0 files to v1.0.0 Phyloref files.

Could be part of the tutorial (#227).

gaurav commented 2 years ago

Instead of recreating the old Brochu 2003 (which contained 17 clade definitions and 5 alternate definitions), we could include the 25 clade definitions from Sangster et al, 2022, which are open access (under the CC-BY-NC-ND license). Unlike Brochu 2003, however, they don't include their own phylogeny down to the species level showing where they expect these clades to resolve, so we would need to include them separately from Prum et al. (2015) and Kuhl et al. (2021).

hlapp commented 2 years ago

Who would curate those definitions? And also, would it be wise to have different example datasets for different software products (if there aren't good reasons as to why one dataset would be much more suitable for one product than another)?

gaurav commented 2 years ago

Who would curate those definitions?

We could use already-curated definitions from the Clade Ontology, as long as we find examples that really exercise Klados. By exercising Klados, I mean:

I think the phylorefs we've curated into JSON for the Clade Ontology has examples of all of these except for a variety of publication sources.

And also, would it be wise to have different example datasets for different software products (if there aren't good reasons as to why one dataset would be much more suitable for one product than another)?

I think there are different needs here: for phyloref.js, we needed something that used a number of Phyx.js features and tested that our Javascript library could process it properly. For the Klados examples, I think we want a number of examples that can show off different functionality in the app -- something we might want to use when demonstrating it to potential users, say. But it would make a lot of sense to move any example Phyx files we generate for this issue into phyloref.js so we can keep checking it during unit tests in that repository.

While working on the tutorial, I found an additional publication that might work as an example:

gaurav commented 2 years ago