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

Should we change the name of the Result classes? #7

Open
d-callan opened this issue Feb 28, 2024 · 1 comment
Open

Should we change the name of the Result classes? #7

d-callan opened this issue Feb 28, 2024 · 1 comment

Comments

@d-callan
Copy link
Contributor

From microbiomeComputations created by asizemore: VEuPathDB/microbiomeComputations#58

Mentioned in #54 , that it's possible our *Result classes are not named optimally.

@d-callan
Copy link
Contributor Author

I spent a while thinking about and discussing this topic today. At the end, i found i actually like our hierarchy and wouldn't change the names unless maybe "Result" -> "Output" or similar. I think it makes sense that CorrelationResult <- ComputeResult since the correlation output is just a computation result but with some extra stuff. Same for diff abund. So having "Result" in both places makes that much more clear. I also like the "Result" (or "Output" ) word itself because to me it says "hey this is everything you get out of doing correlation" which is some values and some correlation-specific metadata.

Those are my 2 cents!

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

No branches or pull requests

1 participant