You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/hello_nf-core/00_orientation.md
+41-13Lines changed: 41 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,34 @@
1
-
# Orientation
1
+
# Getting started
2
2
3
-
## GitHub Codespaces
3
+
To start the course, launch the training environment by clicking the "Open in GitHub Codespaces" button below.
4
+
We recommend opening the training environment in a new browser tab (use right-click, ctrl-click or cmd-click depending on your equipment) so that you can read on while the environment loads.
5
+
You will need to keep these instructions open in parallel.
4
6
5
-
The GitHub Codespaces environment contains all the software, code and data necessary to work through this training course, so you don't need to install anything yourself.
6
-
However, you do need a (free) GitHub account to log in, and you should take a few minutes to familiarize yourself with the interface.
7
+
[](https://codespaces.new/nextflow-io/training?quickstart=1&ref=master)
7
8
8
-
If you have not yet done so, please go through the [Environment Setup](../../envsetup/) mini-course before going any further.
9
+
## Training environment
10
+
11
+
Our training environment runs on GitHub Codespaces (free Github account required) and contains all the software, code and data necessary to work through this training course, so you don't need to install anything yourself.
12
+
13
+
The codespace is set up with a VSCode interface, which includes a filesystem explorer, a code editor and a terminal shell.
14
+
All instructions given during the course (e.g. 'open the file', 'edit the code' or 'run this command') refer to those three parts of the VScode interface unless otherwise specified.
15
+
16
+
If you are working through this course by yourself, please go through the [Environment Setup](../../envsetup/) mini-course for further details before going any further.
9
17
10
18
!!! warning
11
19
12
-
This training is designed for nf-core tools version 3.4.1, which should be the version installed in the codespace. If you use a different version of nf-core tooling you may have difficulty following along.
20
+
This training is designed for nf-core tools version 3.4.1, which should be the version installed in the codespace we provide.
21
+
If you use a different version of nf-core tooling, you may have difficulty following along.
13
22
14
23
You can check what version is installed using the command`nf-core --version`.
15
24
16
-
## Working directory
25
+
## Get ready to work!
17
26
18
-
Throughout this training course, we'll be working in the `hello-nf-core/` directory.
27
+
Once your codespace is running, there are two things you need to do before diving into the training: set your working directory for this specific course, and take a look at the materials provided.
28
+
29
+
### Set the working directory
30
+
31
+
By default, the codespace opens with the work directory set at the root of all training courses, but for this course, we'll be working in the `hello-nf-core/` directory.
19
32
20
33
Change directory now by running this command in the terminal:
21
34
@@ -25,15 +38,15 @@ cd hello-nf-core/
25
38
26
39
!!! tip
27
40
28
-
If for whatever reason you move out of this directory, you can always use the full path to return to it, assuming you're running this within the Github Codespaces training environment:
41
+
If for whatever reason you move out of this directory (e.g. your codespace goes to sleep), you can always use the full path to return to it, assuming you're running this within the Github Codespaces training environment:
29
42
30
43
```bash
31
44
cd /workspaces/training/hello-nf-core
32
45
```
33
46
34
47
Now let's have a look at the contents of this directory.
35
48
36
-
## Materials provided
49
+
###Materials provided
37
50
38
51
You can explore the contents of this directory by using the file explorer on the left-hand side of the training workspace.
39
52
Alternatively, you can use the `tree` command.
@@ -46,7 +59,7 @@ Here we generate a table of contents to the second level down:
46
59
tree . -L 2
47
60
```
48
61
49
-
If you run this inside `hello-nf-core`, you should see the following output:
62
+
If you run this inside `hello-nf-core`, you should see the following output.
50
63
51
64
??? example "Directory contents"
52
65
@@ -67,7 +80,12 @@ If you run this inside `hello-nf-core`, you should see the following output:
67
80
8 directories, 3 files
68
81
```
69
82
70
-
**Here's a summary of what you should know to get started:**
83
+
!!! note
84
+
85
+
We use collapsible sections like this to include expected command output in a concise way.
86
+
Click on the header (here, 'Directory contents') to expand the section and view its contents.
87
+
88
+
**Content guide:**
71
89
72
90
-**The `greetings.csv` file** is a CSV containing some minimal columnar data we use for testing purposes.
73
91
@@ -76,4 +94,14 @@ If you run this inside `hello-nf-core`, you should see the following output:
76
94
-**The `solutions` directory** contains the completed workflow scripts that result from each step of the course.
77
95
They are intended to be used as a reference to check your work and troubleshoot any issues.
78
96
79
-
**Now, to begin the course, click on the arrow in the bottom right corner of this page.**
97
+
## Readiness checklist
98
+
99
+
Think you're ready to dive in?
100
+
101
+
-[ ] I understand the goal of this course and its prerequisites
102
+
-[ ] My codespace is up and running
103
+
-[ ] I've set my working directory appropriately
104
+
105
+
If you checked all the boxes, you're good to go.
106
+
107
+
**To continue to Part 1, click on the arrow in the bottom right corner of this page.**
Copy file name to clipboardExpand all lines: docs/hello_nf-core/index.md
+8-11Lines changed: 8 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,37 +50,34 @@ This training course aims to teach you the core concepts for running nf-core-sty
50
50
We won't cover everything there is to know about nf-core pipelines, because nf-core encompasses many features and conventions developed by the community over years.
51
51
Instead, we will focus on the essential concepts that will help you get started and understand how nf-core works.
52
52
53
-
### Part 1: Run a demo pipeline
53
+
####Part 1: Run a demo pipeline
54
54
55
55
First, you'll **run an existing nf-core pipeline** and examine its code structure to get a sense of what makes these pipelines different from basic Nextflow workflows.
56
56
The elaborate directory structure, configuration system, and standardized conventions might seem like a lot at first, but the benefits will become clear as you learn to decode and utilize these resources effectively.
57
57
58
-
### Part 2: Rewrite Hello for nf-core
58
+
####Part 2: Rewrite Hello for nf-core
59
59
60
60
Next, you'll **adapt an existing workflow to the nf-core template scaffold**, starting from the simple workflow produced in the [Hello Nextflow](../hello_nextflow/index.md) course.
61
61
Many pipeline development efforts start from existing code, so learning how to restructure an existing workflow to leverage nf-core's nested workflow system is a practical skill you're likely to use repeatedly in your work.
62
62
63
-
### Part 3: Use an nf-core module
63
+
####Part 3: Use an nf-core module
64
64
65
65
Then you'll discover one of nf-core's biggest advantages: the **community modules library**.
66
66
Instead of writing every process from scratch, you'll learn to integrate pre-built, tested modules that wrap common bioinformatics tools.
67
67
This approach saves time and ensures consistency across pipelines.
68
68
69
-
### Part 4: Make an nf-core module
69
+
####Part 4: Make an nf-core module
70
70
71
71
Of course, the modules library doesn't have everything, so you'll also learn to **create your own nf-core-style module**.
72
72
You'll learn to work with the specific structure, naming conventions, and metadata requirements that make modules shareable and maintainable by the community.
73
73
74
-
### Part 5: Add input validation
74
+
####Part 5: Add input validation
75
75
76
76
Finally, you'll implement **input validation** for both command-line parameters and input data files using nf-schema.
77
77
This catches errors before pipelines start to run, providing fast feedback and clear error messages. This type of upfront validation makes pipelines more robust and easier to use.
78
78
79
-
By the end of the course, you'll have transformed a basic Nextflow workflow into an nf-core-style pipeline with standardized structure, reusable components, and robust validation.
79
+
**By the end of the course, you'll have transformed a basic Nextflow workflow into an nf-core-style pipeline with standardized structure, reusable components, and robust validation.**
80
80
81
-
## Getting started
81
+
Ready to take the course?
82
82
83
-
Ready to go?
84
-
Launch the training environment in a separate browser tab or window using the "Open in GitHub Codespaces" button below, then navigate to the next section and read on while the environment loads.
85
-
86
-
[](https://codespaces.new/nextflow-io/training?quickstart=1&ref=master){:target="\_blank"}
0 commit comments