Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better error message for UniFrac distances? - issue #53 #168

Open
alejandrocs98 opened this issue Jun 25, 2024 · 2 comments
Open

Better error message for UniFrac distances? - issue #53 #168

alejandrocs98 opened this issue Jun 25, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@alejandrocs98
Copy link

alejandrocs98 commented Jun 25, 2024

Hi David,

Thanks for developing and maintaining MicroViz, what a wonderful tool.

I would like to suggest changing the error message for this issue: @david-barnett in #53 (comment). I wanted to calculate UiFrac distances and got this same error. I spent so much time trying different things to fix it and did not expected that the error was simply for a parameter (that with other distances worked fine). Also, as this issue is closed it took me longer to get to the solution.

Thanks!

@alejandrocs98 alejandrocs98 changed the title Hi Leran, tax_transform with a rank of "Genus" is aggregating the taxa, and so removing the phylogenetic tree, hence the error message. Problem with error message - issue #53 Jun 25, 2024
@david-barnett david-barnett changed the title Problem with error message - issue #53 Better error message for UniFrac distances? - issue #53 Jun 26, 2024
@david-barnett
Copy link
Owner

Hi Alejandro,

Glad you're finding microViz useful 🙂

Currently the error message (when you aggregate taxa before trying to use a unifrac distance) includes the line:

unifrac distances require un-aggregated taxa and a phylogenetic tree

Do you have a suggestion for making this clearer? e.g. what helped you to understand the problem eventually?

cheers
David

@david-barnett david-barnett added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 26, 2024
@alejandrocs98
Copy link
Author

Hi David,

The error message is fine. It was more my bias than anything. When I got the error I instantly assumed that the phylogenetic tree was the problem, when actually the taxa aggregation was the issue.
Although, when searching how to fix this issue almost all blogs and prompts (from AI tools) suggested that the phylogenetic tree was the problem, which might have contributed with my confusion. But to be fair that has nothing to do with the code or the documentation. It really is a very nice tool.

Thank you very much.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants