mozilla / mozanalysis

A library for Mozilla experiments analysis
https://mozilla.github.io/mozanalysis/
Mozilla Public License 2.0
10 stars 13 forks source link

Improve readability of sizing functions #204

Closed m-d-bowerman closed 6 months ago

m-d-bowerman commented 7 months ago

Currently, the functions in sample_size.py (link) return either dictionaries, lists of DataFrames, or lists of dictionaries. We should create a class to hold sample size calculation results to make handling the results more user-friendly.

xluo-ds commented 7 months ago

To help me understand better, currently different data types are returned, and this ticket calls for deliverable as a class to parse the results to standardize them to be more user-friendly. Does different data types currently break anything? @m-d-bowerman

m-d-bowerman commented 7 months ago

They don't, but the current formats require some work from the user depending on what they want to do with them. Dave's sizing notebook that he shared a few weeks ago shows how this could be better, with functionality to display sizing results in a more user-friendly way.