From 30a81a7bb728a3bb88f69005003b30ce0a8e1509 Mon Sep 17 00:00:00 2001 From: Marcel Ribeiro-Dantas Date: Mon, 28 Oct 2024 11:12:03 +0100 Subject: [PATCH 1/2] Fix minor typos on Hello Nextflow --- docs/hello_nextflow/01_orientation.md | 2 +- docs/hello_nextflow/03_hello_containers.md | 8 ++++---- docs/hello_nextflow/07_hello_modules.md | 2 +- docs/hello_nextflow/08_hello_nf-test.md | 2 +- docs/hello_nextflow/09_hello_nf-core.md | 2 +- docs/hello_nextflow/seqera/02_run_with_launchpad.md | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/hello_nextflow/01_orientation.md b/docs/hello_nextflow/01_orientation.md index 8e95c1f58c..ed31bf2709 100644 --- a/docs/hello_nextflow/01_orientation.md +++ b/docs/hello_nextflow/01_orientation.md @@ -10,7 +10,7 @@ If you have not yet done so, please follow [this link](../../envsetup/) before g Throughout this training course, we'll be working in the `hello-nextflow/` directory, which loads by default when you open the Gitpod workspace. This directory contains all the code files, test data and accessory files you will need. -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. +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. Alternatively, you can use the `tree` command. 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. diff --git a/docs/hello_nextflow/03_hello_containers.md b/docs/hello_nextflow/03_hello_containers.md index 824372b295..f14af6ee70 100644 --- a/docs/hello_nextflow/03_hello_containers.md +++ b/docs/hello_nextflow/03_hello_containers.md @@ -202,7 +202,7 @@ process cowSay { container 'community.wave.seqera.io/library/pip_cowsay:131d6a1b707a8e65' ``` -### 2.2. Run nextflow pipelines using containers +### 2.2. Run Nextflow pipelines using containers Run the script to see the container in action. @@ -236,7 +236,7 @@ You should see a new directory called `containers/results` that contains the out Let's take a look at the task directory for one of the cowsay tasks to see how Nextflow works with containers under the hood. -Check your the output form your `nextflow run` command to find the task ID for the `cowsay` process. +Check the output from your `nextflow run` command to find the task ID for the `cowsay` process. Then check out the task directory for that task. ```bash @@ -415,7 +415,7 @@ Doing these exercises is _not required_ to understand later parts of the trainin We have a list of computer and biology pioneers in the `containers/data/pioneers.csv` file. At a high level, to complete this exercise you will need to: -- modify the default `params.input_file` to point to the `pioneers.csv` file. +- Modify the default `params.input_file` to point to the `pioneers.csv` file. - Create a `getQuote` process that uses the `quote` container to fetch a quote for each input. - Connect the output of the `getQuote` process to the `cowsay` process to display the quote. @@ -435,7 +435,7 @@ For the `quote` container image, you can either use the one you built yourself i You can find a solution to this exercise in `containers/scripts/hello-containers-4.1.nf`. -### 4.2. Modify your nextflow pipeline to allow it to execute in `quote` and `sayHello` modes. +### 4.2. Modify your Nextflow pipeline to allow it to execute in `quote` and `sayHello` modes. Add some branching logic using to your pipeline to allow it to accept inputs intended for both `quote` and `sayHello`. Here's an example of how to use an `if` statement in a Nextflow workflow: diff --git a/docs/hello_nextflow/07_hello_modules.md b/docs/hello_nextflow/07_hello_modules.md index f0de8e262b..84dafcadd4 100644 --- a/docs/hello_nextflow/07_hello_modules.md +++ b/docs/hello_nextflow/07_hello_modules.md @@ -43,7 +43,7 @@ hello-modules/ └── nextflow.config ``` -For a detailed description of these files, see the Warmup section in Part 5. +For a detailed description of these files, see the warmup section in Part 5. ### 0.2. Create a symbolic link to the data diff --git a/docs/hello_nextflow/08_hello_nf-test.md b/docs/hello_nextflow/08_hello_nf-test.md index 87e9f7c717..0c65250559 100644 --- a/docs/hello_nextflow/08_hello_nf-test.md +++ b/docs/hello_nextflow/08_hello_nf-test.md @@ -87,7 +87,7 @@ executor > local (7) As expected, it all worked. Like previously, there will now be a `work` directory and a `results_genomics` directory inside your project directory. -However we are going to ignore them entirely, because we are no longer going to touch the pipeline itself, and we're not even going to interact directly with Nextflow as such. +However, we are going to ignore them entirely, because we are no longer going to touch the pipeline itself, and we're not even going to interact directly with Nextflow as such. Instead, we are going to interact with the `nf-test` package. diff --git a/docs/hello_nextflow/09_hello_nf-core.md b/docs/hello_nextflow/09_hello_nf-core.md index 34481d9446..17590df704 100644 --- a/docs/hello_nextflow/09_hello_nf-core.md +++ b/docs/hello_nextflow/09_hello_nf-core.md @@ -134,7 +134,7 @@ Lets' try it! nextflow run nf-core/demo -profile docker,test --outdir results ``` -!!! hint "Changing nextflow version" +!!! hint "Changing Nextflow version" Depending on the nextflow version you have installed, this command might fail due to a version mismatch. If that happens, you can temporarily run the pipeline with a different version than you have installed by adding NXF_VER= to the start of your command as shown below: diff --git a/docs/hello_nextflow/seqera/02_run_with_launchpad.md b/docs/hello_nextflow/seqera/02_run_with_launchpad.md index 45358d31e7..c3080d722c 100644 --- a/docs/hello_nextflow/seqera/02_run_with_launchpad.md +++ b/docs/hello_nextflow/seqera/02_run_with_launchpad.md @@ -16,7 +16,7 @@ Next we want to start using Seqera Platform to launch Nextflow workflows on our Seqera Platform has a concept of [**organizations**](https://docs.seqera.io/platform/latest/orgs-and-teams/organizations) and [**workspaces**](https://docs.seqera.io/platform/latest/orgs-and-teams/workspace-management) which are used to organize and share [pipelines](https://docs.seqera.io/platform/latest/launch/launchpad), [compute environments](https://docs.seqera.io/platform/latest/compute-envs/overview), [data](https://docs.seqera.io/platform/latest/data/data-explorer), [credentials](https://docs.seqera.io/platform/latest/credentials/overview), and more. The `community/showcase` workspace is a public workspace where you can see some example pipelines and compute environments. -Each user has an alloted amount of free compute to use in this workspace. +Each user has an allotted amount of free compute to use in this workspace. Click on your username in the top left corner of the screen to bring up the list of organizations and workspaces you have access to. Select the `community/showcase` workspace. From 99034b82e4f89543b129d4583868b25f6065e898 Mon Sep 17 00:00:00 2001 From: Marcel Ribeiro-Dantas Date: Mon, 28 Oct 2024 11:18:08 +0100 Subject: [PATCH 2/2] Last fix --- docs/hello_nextflow/08_hello_nf-test.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hello_nextflow/08_hello_nf-test.md b/docs/hello_nextflow/08_hello_nf-test.md index 0c65250559..a5924a6e39 100644 --- a/docs/hello_nextflow/08_hello_nf-test.md +++ b/docs/hello_nextflow/08_hello_nf-test.md @@ -49,7 +49,7 @@ hello-nf-test/ └── nextflow.config ``` -For a detailed description of the files, see the Warmup section in Part 6. +For a detailed description of the files, see the warmup section in Part 6. For details about the contents of the `modules` directory, read through all of Part 6 (it's pretty short). ### 0.2. Create a symbolic link to the data