search

fhdsl / FH_WDL101_Cromwell

An introduction to using Cromwell and WDL at the Fred Hutch
https://hutchdatascience.org/FH_WDL101_Cromwell/
Creative Commons Attribution 4.0 International
0 stars 1 forks source link

Idea: troubleshooting example #23

Open jayoung opened 1 year ago

jayoung commented 1 year ago

hi,

The troubleshooting I did yesterday to get annovar working (together with an in-person troubleshoot with Amy last month) made me appreciate the value of understanding failures.

How about having a section of the tutorial where we supply a workflow we know isn't going to work?

We make it fail for some very simple reason, perhaps a problem we think will crop up often - maybe input files aren't found. The tutorial could walk the user through how they would troubleshoot that.

Troubleshooting example 1: today I specified the WDL file but forgot to specify the associated JSON input file before I clicked 'submit workflow'. It took me a while to figure out what I did wrong (and yes, now I know how to troubleshoot that, but I think some people would appreciate a walk-through of what to do with that 'submit jobs-troubleshoot' button).

Troubleshooting example 2: let's say the WDL and JSON are fine, but there's something wrong with the WDL code or perhaps the input files aren't available. Some people will figure out the troubleshooting from the 'track jobs' tab just fine, but I bet others would benefit from a walk-through.

what do you think?

Janet

vortexing commented 1 year ago

I like it!! And so easy to break a workflow so this seems totally doable to do.