qiime2 / provenance-lib

QIIME 2 Provenance Replay Tools
BSD 3-Clause "New" or "Revised" License
3 stars 4 forks source link

Use ExecutionUsage to test validity of written usage examples #52

Open ChrisKeefe opened 2 years ago

ChrisKeefe commented 2 years ago

The ExecutionUsage driver allows us to confirm that a usage example is valid - that, if nothing else, it "goes". This can be used to confirm that the usage examples replay templates out are fundamentally viable, at least in the context of "strict" (original-data, original-metadata) replay. We should test with this.

NOTE: This doesn't guarantee our rendered examples will work. The ReplayPythonUsage driver, for example, renders dummy lines that look something like Metadata.load(<your_metadata.tsv>) - these obviously will not go unless there's a <your_metadata.tsv> in the current working directory.