-
Notifications
You must be signed in to change notification settings - Fork 2
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
Language clarification in extract_diagnostics
#109
Conversation
Thank you for your contribution @zsusswein 🚀! Your pkgdown-site is ready for download 👉 here 👈! |
Codecov ReportAll modified and coverable lines are covered by tests ✅ Additional details and impacted files📢 Thoughts on this report? Let us know! |
b52aea2
to
21c1b6a
Compare
Do you want to rebuild the docs with |
I will. |
Note that it's odd that CI didn't fail (I think?) for the above. I would have thought the website would complain that the docs were not up-to-date? If something missing suggest to add. |
Yeah we need to do this CDCgov/cfa-gam-rt#57 |
Clarified: * "These diagnostics are then flagged if they exceed specific thresholds" makes it sound like the returned dataframe flags each __individually__ (which it doesn't, hence suggest change of language) * "Exceed specific thresholds": sometimes it's if the value is below a threshold hence I suggest reword to "outside acceptable range" Possible refactors / improvements of this function could be: <details> 1. Return a flag for each diagnostic rather than for all of them jointly. Would it ever be useful to know in particular which diagnostic was violated (straight away, I know it could be recovered with some digging) 2. Allowing setting of the thresholds. As a user I imagine this might be useful, like if certain conditions mean that diagnostics are over or under flagging. I can see here it's a bit annoying to do and would probably have to be like a user input list of named values.
8aeaff0
to
b6c32b7
Compare
Clarified:
Two possible refactors / improvements of this function could be: