Skip to content
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

Add validate_model_tbl() convenience function to validate data frame before writing a file. #130

Open
zkamvar opened this issue Oct 18, 2024 · 1 comment
Labels
feature a feature request or enhancement

Comments

@zkamvar
Copy link
Member

zkamvar commented Oct 18, 2024

The impetus for this are the issues encountered in reichlab/variant-nowcast-hub#116

In this, there were problems with the submission, but it's not immediately clear if this was due to the model generating character NAs or if it was due to a problem with file I/O.

At the moment, to validate a submission, we have to write the submission to a hub model-outputs folder and run validate_submission(). This is a good and working setup and I am suggesting a convenience function that validate_submission() can wrap and separate the concerns of validating submission data as opposed to metadata.

By giving the option of validate_model_tbl(), then people can generate the data and validate before writing to disk and they can iterate more rapidly.

It would also help something like reichlab/variant-nowcast-hub/src/sample_submission_data.R demonstrate that the structure of the data is valid. At the moment, whoever runs the script must change the output directory to the model-outputs folder and then clean up the extra file they created in the meantime. If the validate_model_tbl() function were available, then the data could be generated and validated and there would be no mess to clean up or scripts to modify.

It would also allow people to run validations on subsets of their model output (e.g. subsets of optional task ID variables).

@zkamvar
Copy link
Member Author

zkamvar commented Oct 25, 2024

I've gotten feedback from the modelers in the Variant Nowcast Hub that this would be a desired feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement
Projects
Status: Todo
Development

No branches or pull requests

1 participant