More text for lesson 5. Working on formatting.
[rnaseq-cwl-training.git] / lesson5 / lesson5.md
index fe3442d1b07842556d1084e0f319ed1bb72e09c5..54df1348df4b8747970d7062db0454d968dabb0e 100644 (file)
@@ -6,13 +6,14 @@ You might have noticed that the output bam files are all named
 `Aligned.sortedByCoord.out.bam`.  This happens because because when we
 call STAR, it gives the output a default file name.
 
-Now, during workflow execution, this is usually not a problem.  The
+During workflow execution, this is usually not a problem.  The
 workflow runner is smart enough to know that these files are different
 and keep them separate.  This can even make development easier by not
 having to worry about assigning unique file names to every file.
 
 However, it is a problem for humans interpreting the output.  We can
-fix this by setting the parameter `OutFileNamePrefix` on STAR.
+fix this by setting the parameter `OutFileNamePrefix` on STAR.  We
+want the output filename to be based on the input filename.
 
 In `alignment.cwl`, we can use `valueFrom` on the `OutFileNamePrefix`
 input parameter to construct the output prefix from the input
@@ -54,7 +55,42 @@ extension that will be added by STAR.
 
 2. Organizing output files into Directories
 
-This is a more advanced example.
+You probably noticed that all the output files appear in the same
+directory.  You might prefer that each file appears in its own
+directory.  This will show you how to do that.
+
+Unlike shell scripts, in CWL you cannot call `mkdir` and `mv` to
+organize files into directories.  This is because the output files, at
+this point, do not actually exist together in one directory.  They may
+exist on different nodes, in different directories, or different cloud
+buckets.  In CWL, instead of moving files around directly, you tell
+the runner you want your directory to look like, and it will create it
+for you.
+
+We can use an "expression" to create a `Directory` object describing
+each of our directories.  An expression is a piece of Javascript code
+which is executed by the workflow runner to produce values that affect
+the workflow.  These can be a simple as substituting the value of an
+input variable, or as complex as en entire function that generates new
+objects.
+
+Javscript code must be bracketed inside `$(...)` or `${...}`. The
+difference comes down to syntax.  The `$()` form is more compact but
+can only include code that can appear on the right side of an
+assignment (`=`), which cannot include control blocks like `if` or
+`for`.  The `${}` form is a Javascript function, which can include
+control blocks, and must end in a `return` statement.
+
+Dxpressions can both appear in `valueFrom` fields as well as some
+other fields, or in an `ExpressionTool` which, like `Workflow` or
+`CommandLineTool` has explicitly defined `inputs` and `outputs`
+sections.
+
+The approach here is to define an expression tool which takes a
+
+The `Directory` object has two fields, `basename` and `listing`.  The
+`basename` is the name of the directory, and the `listing` is the
+contents, which consists of other File and Directory objects.
 
 Create `subdirs.cwl`: