Add questions/objectives to big picture

Imageomics · Mar 8, 2023 · ac3f06e · ac3f06e
1 parent 50ec884
commit ac3f06e
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/episodes/01_introduction.md b/episodes/01_introduction.md
@@ -12,8 +12,8 @@ teaching: 10
 ::::::::::::::::::::::::::::::::::::::::::::::::
 ::::::::::::::::::::::::::::::::::::: objectives
 
-- Understand why one may use a workflow language like Snakemake
-- Understand the goal of the workshop
+- Understand why one would use a workflow language like Snakemake
+- Understand the goals of the workshop
 
 ::::::::::::::::::::::::::::::::::::::::::::::::
 

diff --git a/episodes/02_snakemake_mindset.md b/episodes/02_snakemake_mindset.md
@@ -25,6 +25,7 @@ teaching: 10
 - Provides support for specifying containers for each rule
 - Provides support for many HPC Clusters including SLURM
 
+TODO
 Explain DAG
 
 ## What is a Snakemake Rule?

diff --git a/episodes/03_big_picture.md b/episodes/03_big_picture.md
@@ -2,6 +2,24 @@
 title: "Workflow Filename Plan"
 teaching: 10
 ---
+:::::::::::::::::::::::::::::::::::::: questions 
+
+- Why should I create a filename plan for a workflow?
+- What are common approaches to filename plans with Snakemake?
+
+::::::::::::::::::::::::::::::::::::::::::::::::
+::::::::::::::::::::::::::::::::::::: objectives
+
+- Understand the filename plan we will be using for the class workflow
+- Understand a high level view of the workflow we will be building
+
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+## Common questions about files in a workflow
+- What did this file come from?
+- Am I still using this file?
+- What code uses this file as an input?
+- Did I have a filename collision?
 
 ## Use directories to organize files
 When working with Snakemake it is important to have a plan for how to organize your files.
@@ -45,7 +63,6 @@ images/dd216t3d.jpg
 Example image:
 ![minnow image](files/bj373514.png){alt='Image of fish'}
 
-
 ## Step 4: Detect fish in each image
 Next we use a tool to determine the location of the fish in each image.
 We will reuse another workflow and use it's filenaming schema for the next 3 steps.
@@ -64,4 +81,3 @@ Finally we create a report using another R script that summarizes the results of
 The HTML report will look something like this:
 ![final report screenshot](files/report.png){alt='Screenshot of html report'}
 We will save the output as `summary/report.html`.
-