-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Improve hub_validations
print method
#116
Improve hub_validations
print method
#116
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is a wonderful change! I think this definitely clarifies and de-clutters the output 🧹 and makes it clear where exactly these errors are coming from.
As always, I have non-blocking suggestions below along with this suggestion:
When I look at a failing check, my first instinct is to use ?check_[check name]
to find details about that particular unit check. Because the model output checks are all prefixed with tbl_
, I stumbled a bit. Could we documentation aliases for the check_tbl_*
functions to be check_*
(e.g. #' @alias check_colnames
for check_tbl_colnames
)?
There are reasons for the prefixes in that they indicate which higher level functions are running the tests and on what aspect (i.e. on the file? on metadata? on the contents of the file? etc). In terms of matching to function docs, I wouldn't want to add aliases that are a mismash of function names and check names but don't actually match up to any correctly. So if we must add aliases I would prefer to add the actual check name. However, there are tables with details of each check at the bottom of each higher level validation function (e.g. here's the help file for validate_submission() and it's pretty easy to tie the check name to the function too so I don't think aliases are strictly necessary. But feel free to open an issue if you think it would really help. |
In this PR I've gone a step further on improving the
hub_validations
print method:hub_validations
class objectcombine()
method now ensures that check names are made unique across allhub_validations
objects being combined.hub_validations
class objectprint()
method.hub_validations
object is now included as the prefix to the check result message instead of the file name (Add name of tests to print out #76).This makes print out much more streamlined and informative. Here's the output of