search

Gilead-BioStats / gsm

Good Statistical Monitoring R Package
https://gilead-biostats.github.io/gsm/
Apache License 2.0
36 stars 9 forks source link

QC: Rename sample data to specify data domain of `analyticsX` or `reportingX` #1662

Closed jonthegeek closed 1 month ago

jonthegeek commented 1 month ago

QC Details

See this comment for a full description.

Additional Comments

jwildfire commented 1 month ago

Heh, I knew this was coming when we split up dfSummary and dfReporting, but I thought we might be able to dodge it for 2.0 ...

There are really 2 slightly different specs for analytics.dfBounds and reporting.dfBounds, so we probably need 2 different data sets. What if we use dfBoundsReporting (or something) to differentiate. A bit hack-y, but maybe ok for now. Can revisit (and possibly update data model) in v2.1.

Another (perhaps better) option (that requires more work) would be rename the sample data to specify which data model it comes from. so, sampleSummary become analyticsSummary, sampleResults becomes reportingResults and we have both analyticsBounds and reportingBounds.

lauramaxwell commented 1 month ago

going with the second option so, sampleSummary become analyticsSummary, sampleResultsbecomes reportingResults(and so on) and we have both analyticsBoundsand reportingBounds