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

augur validate output isn't easily interpretable #440

Closed
crashfrog opened this issue Feb 5, 2020 · 2 comments · Fixed by #441
Closed

augur validate output isn't easily interpretable #440

crashfrog opened this issue Feb 5, 2020 · 2 comments · Fixed by #441

Comments

@crashfrog
Copy link

$ augur version
augur 6.2.0
$ augur validate export-v2 senterica_aroC_5_dnaN_2_hemD_3_hisD_7_purE_6_sucA_6_thrA_11.json
Validation succeeded
Validating that the JSON is internally consistent
	WARNING:  The filter "location" does not appear as a property on any tree nodes.
	WARNING:  The filter "author" does not appear as a property on any tree nodes.
Validation failed

Hard to make sense of this output. Did validation succeed, or fail? (It exited with code 0.) If it failed what was the failure? Are the warnings actually meant to be failures? Why don't location or author appear as properties on the nodes if they're part of the metadata file given to augur export?

tsibley added a commit that referenced this issue Feb 10, 2020
Distinguishes between schema validation and internal consistency (e.g.
data) checks and includes filenames in top-level messages so the subject
is clear.

Resolves #440.
@tsibley
Copy link
Member

tsibley commented Feb 10, 2020

Hi @crashfrog, thanks for this report. I agree the messages here are pretty confusing. Right now the validation code is a bit ad-hoc and messaging isn't unified. I've tried to clean up and clarify some of that in #441.

Although it's totally unclear, your file did validate, but there were some non-critical warnings you might want to resolve regarding location and author filters which won't work because no nodes have those traits.

The nodes probably lacked those traits because although your metadata file given to augur export v2 contained them, the export wasn't configured to pass them through using --metadata-color-by. See the Traits section of Migrating from Augur v5 to v6. This is a new default to prevent slurping in all of the metadata file into the export, which is particularly important when the metadata file might contain both public and protected information, only some of which is allowed to make it into the exported JSONs. @emmahodcroft might be able to offer a more detailed diagnosis here too. If you need help resolving these warnings, please feel free to open a new issue with the full steps and files you used for running augur export v2 so we can reproduce it.

tsibley added a commit that referenced this issue Feb 10, 2020
Distinguishes between schema validation and internal consistency (e.g.
data) checks and includes filenames in top-level messages so the subject
is clear.

Resolves #440.
@crashfrog
Copy link
Author

Thanks, that's helpful. I'll review the documentation you linked, I hadn't seen that before.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants