Skip to content

Commit d26900a

Browse files
vdauweramaxulyssekenibrewer
authored
Add Hello-channels, stub for containers etc and reorder training modules (#391)
Reorder training modules and add stubs to expand the series, improve instructions and add explanations throughout, update GATK flowcharts, improve flow and improve formatting. Notable changes: * In Hello-World, start by looking at the code before running it * Convert the splitText to splitCsv in Hello-World * Add stub for new Hello-Containers module (Ken) * Rename Hello-GATK to Hello-Science * Simplify Hello-Science by moving GVCF and joint genotyping out to new Hello-Channels module based on Adam's proposal in #367 * Improve flow of joint genotyping in Hello-Channels --------- Co-authored-by: Maxime U Garcia <[email protected]> Co-authored-by: Ken Brewer <[email protected]>
1 parent 2e1b6c0 commit d26900a

19 files changed

+2091
-1050
lines changed
Lines changed: 24 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,33 @@
11
# Orientation
22

3-
The Gitpod environment contains some test data that will be used in this workshop. All software required are already installed and configured in it too.
3+
The Gitpod environment contains some test data that will be used in this training course. All software required is already installed and configured in it too.
44

55
!!! note
66

7-
Follow [this link](../../envsetup/) if you have not yet setup your Gitpod environment.
7+
Follow [this link](../../envsetup/) if you have not yet set up your Gitpod environment.
88

9-
## Getting started
9+
## Materials provided
1010

11-
You will complete this module in the `hello-nextflow/` folder.
11+
Throughout this training course, we'll be working in the `hello-nextflow/` directory.
1212

1313
```bash
1414
cd /workspace/gitpod/hello-nextflow
1515
```
1616

17-
In this folder you will all test data, code and accessory needed to work through this training module.
17+
This directory contains all the code files, test data and accessory files you will need. Feel free to explore the contents of this directory; an easy way to see what it contains is the use the `tree` command (here we generate a table of contents to the second level down).
1818

19-
!!! question "Exercise"
20-
21-
View all the folder and files in the `hello-nextflow` directory.
22-
23-
```console
24-
tree .
25-
```
19+
```bash
20+
tree . -L 2
21+
```
2622

2723
You should see the following output:
2824

29-
```console title="Output"
25+
```console title="Directory contents"
3026
/workspace/gitpod/hello-nextflow
3127
├── data
3228
│ ├── bam
33-
│ │ ├── reads_father.bam
34-
│ │ ├── reads_mother.bam
35-
│ │ └── reads_son.bam
36-
│ ├── greetings.txt
37-
│ ├── intervals.list
38-
│ ├── ref.tar.gz
29+
│ ├── greetings.csv
30+
│ ├── ref
3931
│ ├── sample_bams.txt
4032
│ └── samplesheet.csv
4133
├── hello-gatk.nf
@@ -44,6 +36,10 @@ You should see the following output:
4436
├── hello-world.nf
4537
├── nextflow.config
4638
└── scripts
39+
├── hello-config-1.config
40+
├── hello-config-2.config
41+
├── hello-config-3.config
42+
├── hello-config-4.config
4743
├── hello-gatk-1.nf
4844
├── hello-gatk-2.nf
4945
├── hello-gatk-3.nf
@@ -53,7 +49,6 @@ You should see the following output:
5349
├── hello-modules-1.nf
5450
├── hello-modules-2.nf
5551
├── hello-modules-3.nf
56-
├── hello-world-10.nf
5752
├── hello-world-1.nf
5853
├── hello-world-2.nf
5954
├── hello-world-3.nf
@@ -64,40 +59,22 @@ You should see the following output:
6459
├── hello-world-8.nf
6560
├── hello-world-9.nf
6661
├── modules
67-
│ └── local
68-
│ ├── gatk
69-
│ │ ├── haplotypecaller
70-
│ │ │ └── main.nf
71-
│ │ └── jointgenotyping
72-
│ │ ├── main.nf
73-
│ │ └── tests
74-
│ │ └── inputs
75-
│ │ ├── family_trio_map.tsv
76-
│ │ ├── reads_father.bam.g.vcf
77-
│ │ ├── reads_father.bam.g.vcf.idx
78-
│ │ ├── reads_mother.bam.g.vcf
79-
│ │ ├── reads_mother.bam.g.vcf.idx
80-
│ │ ├── reads_son.bam.g.vcf
81-
│ │ └── reads_son.bam.g.vcf.idx
82-
│ └── samtools
83-
│ └── index
84-
│ └── main.nf
8562
└── nextflow.config
8663

87-
12 directories, 43 files
64+
13 directories, 48 files
8865

8966
```
9067

91-
Each file will be used in this training module.
92-
93-
**The `data` directory** contains the input data we'll use in Part 2: Hello GATK, which uses an example from genomics to demonstrate how to build a simple analysis pipeline. The data is described in detail in that section of the training.
68+
**The `data` directory** contains the input data we'll use in Part 3: Hello Science, which uses an example from genomics to demonstrate how to build a simple analysis pipeline.
69+
The data are described in detail in that section of the course.
9470

95-
**The `scripts` directory** contains the completed workflow scripts that result from each step of the tutorial and are intended to be used as a reference to check your work. The name and number in the filename correspond to the step of the relevant tutorial. For example, the file `hello-world-4.nf` is the expected result of completing steps 1 through 4 of Part 1: Hello World.
71+
**The file `nextflow.config`** is a configuration file that sets minimal environment properties.
9672

97-
**The file `greetings.txt`** is a plain text file used to provide inputs in Part 1: Hello World.
73+
**The file `hello-world.nf`** is a simple but fully functional workflow script that serves as a starting point to Part 1: Hello World.
9874

99-
**The file `hello-gatk.nf`** is a stub that serves as a starting point to Part 2: Hello GATK. In its initial state, it is NOT a functional workflow script.
75+
**The file `hello-gatk.nf`** is a stub that serves as a starting point to Part 3: Hello Science.
76+
In its initial state, it is NOT a functional workflow script.
10077

101-
**The file `hello-world.nf`** is a simple but fully functional workflow script that serves as a starting point to Part 1: Hello World.
78+
**The remaining `.nf` files** are functional workflow scripts that serve as starting points for the corresponding parts of the course.
10279

103-
**The file `nextflow.config`** is a configuration file that sets minimal environment properties.
80+
**The `scripts` directory** contains the completed workflow scripts that result from each step of the course. They are intended to be used as a reference to check your work and troubleshoot any issues. The name and number in the filename correspond to the step of the relevant part of the course. For example, the file `hello-world-4.nf` is the expected result of completing steps 1 through 4 of Part 1: Hello World.

0 commit comments

Comments
 (0)