qiime2 / provenance-lib

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

ENH: early stopping in replay scripts #82

Open nbokulich opened 2 years ago

nbokulich commented 2 years ago

related to #81

the replay scripts have comment lines and placeholders for unknown parameters and filepaths. This is great!

But this also creates a problem, namely that the scripts are then not executable "out of the box". This is fine, they should not be expected to be (nor is "touchless replay" necessarily even the goal here), but it could create issues if a user naively attempts to run a script that has not yet been adapted.

this could be partially fixed by including instructions for making the script executable (#81 )

but it would also be nice to insert an exit line or similar (with comments/instructions to remove after other edits are made), so that users do not attempt to run a broken provenance replay script.

ChrisKeefe commented 2 years ago

Great idea, @nbokulich! A couple minor clarifications: