Skip to content

Commit d7ee6c2

Browse files
authored
Updates to the wording and tree output (#417)
1 parent a1ea602 commit d7ee6c2

File tree

1 file changed

+61
-48
lines changed

1 file changed

+61
-48
lines changed

docs/hello_nextflow/01_orientation.md

Lines changed: 61 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,93 @@
11
# Orientation
22

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.
3+
The Gitpod environment contains all the software, code and data necessary to work through this training course, so you don't need to install anything yourself.
4+
However, you do need a (free) account to log in, and you should take a few minutes to familiarize yourself with the interface.
45

5-
!!! note
6-
7-
Follow [this link](../../envsetup/) if you have not yet set up your Gitpod environment.
6+
If you have not yet done so, please follow [this link](../../envsetup/) before going any further.
87

98
## Materials provided
109

11-
Throughout this training course, we'll be working in the `hello-nextflow/` directory.
10+
Throughout this training course, we'll be working in the `hello-nextflow/` directory, which loads by default when you open the Gitpod workspace.
11+
This directory contains all the code files, test data and accessory files you will need.
1212

13-
```bash
14-
cd /workspace/gitpod/hello-nextflow
15-
```
13+
Feel free to explore the contents of this directory; the easiest way to do so is to use the file explorer on the left hand side of the Gitpod workspace.
14+
Alternatively, you can use the `tree` command.
15+
Throughout the course, we use the output of `tree` to represent directory structure and contents in a readable form, sometimes with minor modifications for clarity.
1616

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).
17+
Here we generate a table of contents to the second level down:
1818

1919
```bash
2020
tree . -L 2
2121
```
2222

23-
You should see the following output: **TODO: UPDATE**
23+
If you run this inside `hello-nextflow`, you should see the following output:
2424

2525
```console title="Directory contents"
26-
/workspace/gitpod/hello-nextflow
26+
.
27+
├── containers
28+
│ ├── build
29+
│ ├── data
30+
│ ├── results
31+
│ └── scripts
2732
├── data
2833
│ ├── bam
2934
│ ├── greetings.csv
3035
│ ├── ref
3136
│ ├── sample_bams.txt
3237
│ └── samplesheet.csv
33-
├── hello-gatk.nf
34-
├── hello-modules.nf
35-
├── hello-nf-test.nf
38+
├── hello-config
39+
│ ├── demo-params.json
40+
│ ├── main.nf
41+
│ └── nextflow.config
42+
├── hello-containers.nf
43+
├── hello-genomics.nf
44+
├── hello-modules
45+
│ ├── demo-params.json
46+
│ ├── main.nf
47+
│ └── nextflow.config
48+
├── hello-nf-test
49+
│ ├── demo-params.json
50+
│ ├── main.nf
51+
│ └── nextflow.config
52+
├── hello-operators.nf
3653
├── hello-world.nf
3754
├── nextflow.config
3855
└── solutions
39-
├── hello-config-1.config
40-
├── hello-config-2.config
41-
├── hello-config-3.config
42-
├── hello-config-4.config
43-
├── hello-gatk-1.nf
44-
├── hello-gatk-2.nf
45-
├── hello-gatk-3.nf
46-
├── hello-gatk-4.nf
47-
├── hello-gatk-5.nf
48-
├── hello-gatk-6.nf
49-
├── hello-modules-1.nf
50-
├── hello-modules-2.nf
51-
├── hello-modules-3.nf
52-
├── hello-world-1.nf
53-
├── hello-world-2.nf
54-
├── hello-world-3.nf
55-
├── hello-world-4.nf
56-
├── hello-world-5.nf
57-
├── hello-world-6.nf
58-
├── hello-world-7.nf
59-
├── hello-world-8.nf
60-
├── hello-world-9.nf
61-
├── modules
62-
└── nextflow.config
63-
64-
13 directories, 48 files
65-
56+
├── hello-config
57+
├── hello-genomics
58+
├── hello-modules
59+
├── hello-nf-test
60+
├── hello-operators
61+
└── hello-world
62+
63+
18 directories, 17 files
6664
```
6765

68-
**The `data` directory** contains the input data we'll use in Part 3: Hello Genomics, which uses an example from genomics to demonstrate how to build a simple analysis pipeline.
69-
The dataset is described in detail in that section of the course.
66+
Don't worry if this seems like a lot; we'll go through the relevant pieces at each step of the course.
67+
This is just meant to give you an overview.
68+
69+
Here's a summary of what you should know to get started:
70+
71+
**The `.nf` files** are workflow scripts that are named based on what part of the course they're used in.
72+
73+
**The `hello-*` directories** are directories used in the later Parts of the course where we are working with more than just one workflow file.
7074

7175
**The file `nextflow.config`** is a configuration file that sets minimal environment properties.
76+
You can ignore it for now.
77+
78+
**The `data` directory** contains the input data we'll use in most of the course. The dataset is described in detail in Part 3, when we introduce it for the first time.
79+
80+
**The `solutions` directory** contains the completed workflow scripts that result from each step of the course.
81+
They are intended to be used as a reference to check your work and troubleshoot any issues.
82+
The name and number in the filename correspond to the step of the relevant part of the course.
83+
For example, the file `hello-world-4.nf` is the expected result of completing steps 1 through 4 of Part 1: Hello World.
7284

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.
85+
!!!tip
7486

75-
**The file `hello-gatk.nf`** is a stub that serves as a starting point to Part 3: Hello Genomics.
76-
In its initial state, it is NOT a functional workflow script.
87+
If for whatever reason you move out of this directory, you can always run this command to return to it:
7788

78-
**The remaining `.nf` files** are functional workflow scripts that serve as starting points for the corresponding parts of the course.
89+
```bash
90+
cd /workspace/gitpod/hello-nextflow
91+
```
7992

80-
**The `solutions` directory** contains the completed workflow scripts and other files that you will generate in each part 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.
93+
Now, to begin the course, click on the arrow in the bottom right corner of this page.

0 commit comments

Comments
 (0)