Skip to content

docs: clarify rarefaction handling in alpha and beta diversity calculations - #27

Merged
ilypopv merged 1 commit into
mainfrom
fix/paper
Sep 2, 2026
Merged

ilypopv merged 1 commit into
mainfrom
fix/paper

Conversation

@ilypopv

@ilypopv ilypopv commented Sep 2, 2026

Copy link
Copy Markdown
Member

📝 Summary

Updated the paper's diversity calculations section to correct the documentation of rarefaction behavior. Alpha diversity is now described as computed on raw (unrarefied) counts, while beta diversity is documented as applying rarefaction prior to distance matrix calculation.

🛠 Type of Change

  • Documentation

🔍 Key Changes

  • Updated the comparison table to note alpha diversity is computed on raw counts and beta diversity includes rarefaction
  • Rewrote the Alpha Diversity bullet to remove the claim of a built-in rarefaction procedure subsampling reads beforehand
  • Rewrote the Beta Diversity bullet to state that rarefaction is applied prior to distance matrix calculation to account for uneven sequencing depths

🧪 How Has This Been Tested?

  • Manual review of the updated paper/paper.md text against the documented diversity computation behavior

@ilypopv
ilypopv marked this pull request as ready for review September 2, 2026 15:12
@ilypopv
ilypopv merged commit 3097c8f into main Sep 2, 2026
6 checks passed
@ilypopv
ilypopv deleted the fix/paper branch September 2, 2026 15:12
@codecov

codecov Bot commented Sep 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant