search

VEuPathDB / microbiomeComputations

1 stars 0 forks source link

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

Open asizemore opened 10 months ago

asizemore commented 10 months ago

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

asizemore commented 10 months ago

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!