EcoJulia / Microbiome.jl

For analysis of microbiome and microbial community data
Other
47 stars 10 forks source link

Distance metrics #57

Closed pknight24 closed 3 years ago

pknight24 commented 3 years ago

Implements Jaccard and Hellinger distances for AbstractAbundanceTable

These commits add methods for computing the Jaccard and Hellinger distances for the AbstractAbundanceTable type. I find myself using these relatively often, and figured it would be helpful to write a quick implementation for this package.

I tried to be a thorough as possible, but if anything is missing or incorrect, please let me know and I'll be sure to make any necessary changes.

Thanks! Parker

Types of changes

This PR implements the following changes:

:ballot_box_with_check: Checklist

kescobo commented 3 years ago

Awesome, looks great! Well get it merged as soon as I'm at my laptop. 2 things:

  1. Can you double check that the docstrings will be built (they should be somewhere in a @docs block somewhere in docs/src/...)
  2. Can you increment the version number in Project.toml?
pknight24 commented 3 years ago

This commit bumps the version number to 0.8.0. The docstrings are included in the @docs block indocs/src/diversity.md.

kescobo commented 3 years ago

Oh sorry - just the patch version (so 0.7.1). Prior to v1.0, changes to the middle number indicate breaking changes, but since this is just adding some stuff, it shouldn't break anything. Apologies for not being clear 🤦‍♂️

pknight24 commented 3 years ago

No worries! Fixing now.

kescobo commented 3 years ago

Alright - new version tagged and merged! Thanks for the contribution :pray: