Skip to content

Commit 5d933c9

Browse files
authored
Merge pull request #18 from Sydney-Informatics-Hub/dev-update-session-2
Merge session 2 parts 2.0, 2.1, 2.2 ready for collaborator review
2 parents 46c6d0e + 7baa414 commit 5d933c9

11 files changed

Lines changed: 1576 additions & 1283 deletions

docs/assets/2.1_input_help.png

114 KB
Loading
5.61 KB
Loading
58.6 KB
Loading
-17.7 KB
Loading

docs/session_2/2.0_intro.md

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,39 @@
1-
# 2.0 Introduction to session 2
1+
# 2.0 Introduction to Session 2
22

3-
This session builds on fundamental concepts learned in [Session 1](1.0_intro.md) and provides you with hands-on experience in nf-core workflow customisation. Throughout the session we will be working with data from a [published RNAseq study](https://bmcgenomics.biomedcentral.com/articles/10.1186/s12864-016-2801-4) and the [nf-core/rnaseq pipeline](https://nf-co.re/rnaseq/3.11.1).
3+
This session builds on [Session 1](../session_1/1.0_intro.md), where we explored the core features of nf-core and Nextflow and learnt the fundamental commands and options for executing nf-core pipelines:
44

5-
We will explore the pipeline source code and apply various customisations using a parameter file and custom configuration files. You will:
5+
- nf-core is a curated set of analysis pipelines built using the workflow language Nextflow
6+
- nf-core pipelines are composed of a modular collection of workflows, subworkflows, and modules (processes) where each process performs a discrete analysis task
7+
- The run can be customised with pipeline parameters (`--`), Nextflow parameters (`-`), and custom configuration files
8+
- Nextflow `run` command starts the workflow
9+
- Nextflow `log` can be used to inspect run details
10+
11+
At the end of session 1, we downloaded the [nf-core/rnaseq](https://nf-co.re/rnaseq/3.23.0) pipeline and submitted our first run.
12+
13+
During Session 2, we will continue with this pipeline, using the same data from a [published mouse RNAseq study](https://bmcgenomics.biomedcentral.com/articles/10.1186/s12864-016-2801-4). Pipeline outputs and source code will be explored, and various customisations will be applied using parameters and configuration files to provide you with hands-on experience in nf-core pipeline customisation.
614

7-
* Create these files for our case study
8-
* Use the nf-core tools utility
9-
* Run Nextflow commands to query work directories and configuration files
10-
* Write some custom Bash code to efficiently extract information from the source code
1115

12-
Each lesson in this session will build on the previous lessons, so you can gain a deeper understanding of the customisation techniques and the impact they have on the workflow and your results :nerd_face:
1316

1417
!!! note "Applying what you learn here to other nf-core workflows"
1518

16-
While all activities in this session will be performed using the nf-core/rnaseq workflow, all customisation scenarios we explore are applicable to other nf-core workflows and do not require an understanding of RNAseq data processing.
19+
While all activities in this session use the nf-core/rnaseq workflow, the customisation scenarios we explore are applicable to other nf-core workflows and do not require an understanding of RNA-seq data processing.
20+
These skills transfer to other nf-core pipelines thanks to Nextflow as a domain-specific workflow language designed to make workflows portable, and the [nf-core specifications](https://nf-co.re/docs/specifications) placing a strong emphasis on modularity and consistency in code and architecture.
21+
1722

18-
## 2.0.1 Log back in to your instance
23+
<br>
1924

20-
Follow [set up instructions](../setup.html) to log back into your instance in either VS Code or your terminal.
25+
!!! example "Exercise 2.0.1 :stopwatch: 2 mins"
2126

22-
In VS Code:
27+
Follow the [set up instructions](../setup.md) to log back into your Nectar VM in either VS Code or your terminal.
2328

24-
1. Type `Ctrl` + `Shift` + `P` to open command palette and select `Remote-SSH: Connect to Host` and `nfcoreWorkshop`
25-
2. Type in your provided password (see the Slack channel for the password) and hit enter
29+
In VS Code:
2630

27-
**OR**
31+
1. Type `Ctrl` + `Shift` + `P` to open command palette and select `Remote-SSH: Connect to Host`
32+
2. Select the IP address for your VM from the drop-down list
33+
3. Type in your provided password and hit enter
2834

29-
In a terminal application:
35+
Change into the session 2 directory created in the previous session:
3036

31-
1. Type the following into your terminal, using your allocated instance’s IP address:
3237
```default
33-
ssh training@146.118.XXX.XX
38+
cd session2
3439
```
35-
2. Type in your provided password (see the Slack channel for the password) and hit enter
36-
37-
## 2.0.2 Create a new work directory
38-
39-
Create a new directory for all session 2 activities and move into it:
40-
41-
```default
42-
mkdir ~/session2 && cd $_
43-
```

docs/session_2/2.1_params.md

Lines changed: 462 additions & 169 deletions
Large diffs are not rendered by default.

docs/session_2/2.2_config.md

Lines changed: 550 additions & 0 deletions
Large diffs are not rendered by default.

docs/session_2/2.2_env.md

Lines changed: 0 additions & 555 deletions
This file was deleted.

docs/session_2/2.3_custom.md

Lines changed: 2 additions & 529 deletions
Large diffs are not rendered by default.

docs/session_2/2.3_custom.md-old

Lines changed: 536 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)