Skip to content
This repository was archived by the owner on Mar 6, 2026. It is now read-only.

Commit ac3f06e

Browse files
committed
Add questions/objectives to big picture
1 parent 50ec884 commit ac3f06e

3 files changed

Lines changed: 21 additions & 4 deletions

File tree

episodes/01_introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ teaching: 10
1212
::::::::::::::::::::::::::::::::::::::::::::::::
1313
::::::::::::::::::::::::::::::::::::: objectives
1414

15-
- Understand why one may use a workflow language like Snakemake
16-
- Understand the goal of the workshop
15+
- Understand why one would use a workflow language like Snakemake
16+
- Understand the goals of the workshop
1717

1818
::::::::::::::::::::::::::::::::::::::::::::::::
1919

episodes/02_snakemake_mindset.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ teaching: 10
2525
- Provides support for specifying containers for each rule
2626
- Provides support for many HPC Clusters including SLURM
2727

28+
TODO
2829
Explain DAG
2930

3031
## What is a Snakemake Rule?

episodes/03_big_picture.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,24 @@
22
title: "Workflow Filename Plan"
33
teaching: 10
44
---
5+
:::::::::::::::::::::::::::::::::::::: questions
6+
7+
- Why should I create a filename plan for a workflow?
8+
- What are common approaches to filename plans with Snakemake?
9+
10+
::::::::::::::::::::::::::::::::::::::::::::::::
11+
::::::::::::::::::::::::::::::::::::: objectives
12+
13+
- Understand the filename plan we will be using for the class workflow
14+
- Understand a high level view of the workflow we will be building
15+
16+
::::::::::::::::::::::::::::::::::::::::::::::::
17+
18+
## Common questions about files in a workflow
19+
- What did this file come from?
20+
- Am I still using this file?
21+
- What code uses this file as an input?
22+
- Did I have a filename collision?
523

624
## Use directories to organize files
725
When working with Snakemake it is important to have a plan for how to organize your files.
@@ -45,7 +63,6 @@ images/dd216t3d.jpg
4563
Example image:
4664
![minnow image](files/bj373514.png){alt='Image of fish'}
4765

48-
4966
## Step 4: Detect fish in each image
5067
Next we use a tool to determine the location of the fish in each image.
5168
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
6481
The HTML report will look something like this:
6582
![final report screenshot](files/report.png){alt='Screenshot of html report'}
6683
We will save the output as `summary/report.html`.
67-

0 commit comments

Comments
 (0)