Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Language clarification in
extract_diagnostics
(#109)
* Language clarification in `extract_diagnostics` 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. * Redocument
- Loading branch information