Skip to content

Commit 460cbc0

Browse files
committed
WIP: Making suggested changes to index, setup, 1.1
1 parent b7f5fd0 commit 460cbc0

3 files changed

Lines changed: 19 additions & 18 deletions

File tree

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ This workshop will provide you with the foundational knowledge required to run a
44

55
## Trainers
66

7-
- Cali Willet, Sydney Informatics Hub, University of Sydney
87
- Michael Geaghan, Sydney Informatics Hub, University of Sydney
8+
- Cali Willet, Sydney Informatics Hub, University of Sydney
99

1010
## Prerequisites
1111

@@ -48,9 +48,9 @@ This workshop event and accompanying materials were developed by the Sydney Info
4848

4949
### Contributors
5050

51-
- Georgie Samaha, Sydney Informatics Hub, University of Sydney
51+
- Michael Geaghan, Sydney Informatics Hub, University of Sydney
5252
- Cali Willet, Sydney Informatics Hub, University of Sydney
53+
- Georgie Samaha, Sydney Informatics Hub, University of Sydney
5354
- Chris Hakkaart, Seqera Labs
54-
- Michael Geaghan, Sydney Informatics Hub, University of Sydney
5555

5656
![](./assets/0.0_logos.png)

docs/session_1/1.1_nfcore.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
!!! tip "Objectives"
44

5-
- Learn about nf-core and its core features.
6-
- Learn about the core features of Nextflow.
7-
- Understand nf-core workflow structure.
8-
- Learn Nextflow terminology.
9-
- Learn about the nf-core community.
5+
- Learn about nf-core and its core features
6+
- Learn about the core features of Nextflow
7+
- Understand nf-core workflow structure
8+
- Learn Nextflow terminology
9+
- Learn about the nf-core community
1010

1111
## 1.1.1 What is nf-core?
1212

@@ -26,9 +26,9 @@ nf-core is published in Nature Biotechnology: [Nat Biotechnol 38, 276–278 (202
2626

2727
- **Documentation**
2828
- nf-core workflows have extensive documentation covering installation, usage, and description of output files to ensure that you won't be left in the dark.
29-
- **CI Testing**
30-
- Every time a change is made to the workflow code, nf-core workflows use continuous-integration testing to ensure that nothing has broken.
31-
- **Stable Releases**
29+
- **Continuous integration testing**
30+
- Every time a change is made to the workflow code, nf-core workflows use continuous integration (CI) testing to ensure that nothing has broken.
31+
- **Stable releases**
3232
- nf-core workflows use GitHub releases to tag stable versions of the code and software, making workflow runs totally reproducible.
3333
- **Packaged software**
3434
- Pipeline dependencies are automatically downloaded and handled using Docker, Singularity, Conda, or other software management tools. There is no need for any software installations.
@@ -43,14 +43,14 @@ It is important to remember all nf-core workflows are **open-source** and **comm
4343

4444
![](../assets/1.1_nextflow.png){width=100%}
4545

46-
Nextflow is the workflow language and engine that underlies all nf-core pipelines. It is designed around the idea that the Linux platform is the lingua franca of data science. Linux provides many simple but powerful command-line and scripting tools that, when chained together, facilitate complex data manipulations. Nextflow extends this approach, adding the ability to define complex program interactions and a high-level parallel computational environment based on the dataflow programming model.
46+
Nextflow is the workflow language and engine that underlies all nf-core pipelines. It is designed to provide a robust framework that lets us chain together all the command-line tools and scripts we need for our analyses into a single pipeline that is easy to execute.
4747

4848
**Nextflow’s core features are:**
4949

5050
- Workflow portability and reproducibility
5151
- Workflow logic is separated from configuration, allowing workflows to be "written once and run anywhere" - from local machines to high performance computing (HPC) clusters and the cloud.
5252
- Scalability through parallelisation
53-
- Workflows define **processes** (individual computational tasks to run) and **channels** that define how data flows between them; this model natively takes advantage of parallelisation as datasets grow in size, allowing the same workflow code to efficiently process small and large datasets equally.
53+
- Workflows define **processes** (individual computational tasks to run) and **channels** that define how data flows between them; this model natively takes advantage of parallelisation as datasets grow in size, allowing the same workflow code to seamlessly adapt to processing datasets with varying numbers of input samples with equal efficiency.
5454
- Flexible configuration
5555
- Nextflow supports defining configuration profiles and additional configuration files to override default settings and fine-tune processes for specific environments and datasets.
5656
- Integration of existing tools, systems, and industry standards.
@@ -61,12 +61,12 @@ Because of these features, Nextflow has become one of the most prevalent workflo
6161

6262
In today's workshop, we will be focusing on the configurability of nf-core pipelines, and so won't be further exploring the inner workings of Nextflow. If you would like more information about how Nextflow works and how to write your own pipelines, you can see our [Nextflow for Life Sciences training material](https://sydney-informatics-hub.github.io/hello-nextflow-2025/), as well as the [Nextflow documentation website](https://docs.seqera.io/nextflow).
6363

64-
!!! abstract Poll 1.1.2"
64+
!!! abstract "Poll 1.1.2"
6565

6666
One of Nextflow's strengths is that it can be run on many different platforms and can run scripts written in lots of programming languages. Let us know:
6767

6868
1. What platform do you run your bioinformatics workflows on? A desktop or laptop? An institutional HPC?
69-
2. What language to you prefer to write your scripts in? Bash? Python? R? Perl?
69+
2. What language do you prefer to write your scripts in? Bash? Python? R? Perl? Something else?
7070

7171
## 1.1.3 nf-core workflow structure
7272

@@ -116,5 +116,6 @@ Upcoming events are listed on the [nf-core event page](https://nf-co.re/events)
116116

117117
!!! note "Key points"
118118

119-
- nf-core is a community effort to collect a curated set of analysis workflows built using Nextflow.
120-
- Nextflow is a workflow management engine and coding language that makes it easy to write data-intensive computational workflows.
119+
- nf-core is a community effort to collect a curated set of analysis workflows built using Nextflow
120+
- Nextflow is a workflow management engine and coding language for data-intensive computational workflows
121+
- nf-core workflows are written in Nextflow, combining a series of modules and subworkflows into a main workflow

docs/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Having successfully logged in, you should see a small blue or green box in the b
5454

5555
### Install extensions on the remote machine
5656

57-
We will now install some helpful VS Code extensions to help with Nextflow syntax highlighting and viewing reports on the remote machine:
57+
We will now install some helpful VS Code extensions. The "Nextflow" extension adds Nextflow-specific syntax highlighting. The "Live Server" extension enables us to view HTML reports on the remote machine without having to download them first.
5858

5959
1. Ensure you are still connected to the VM as above.
6060
2. Click on the extensions button (four blocks) on the left side bar.

0 commit comments

Comments
 (0)